This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.
The default sort
is id
in ASC
.
For a detailed list of supported operations, see Projects: Supported Filters and Sorting. To learn how to query projects, see API Query Language.
Query options.
Whether to include the project's relative path and full URL in the response. Default: false
List of projects.
Paging metadata.
curl -X POST \
'https://www.wixapis.com/api/v1/portfolio/projects/query' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"query": {
"filter": {
"title": {
"$contains": "Project"
}
},
"sort": [
{
"fieldName": "createdDate",
"order": "ASC"
}
],
"cursorPaging": {
"limit": 10
}
},
"includePageUrl": true
}'
{
"projects": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"revision": 1,
"title": "Project Title",
"description": "Project Description",
"hidden": false,
"coverImage": {
"imageInfo": {
"id": "9ab44e4567-e89b-12d3-a456-4266141747",
"url": "https://example.com/updated_cover_image1.jpg"
}
}
"collectionIds": ["123e4567-e89b-12d3-a456-426614174001"],
"slug": "project-title",
"details": [
"label": "link",
"link": {
"text": "Learn more about my project.",
"url": "www.my-project.com",
"target": "'_blank'"
}
],
"createdDate": "2024-07-31T12:00:00Z",
"updatedDate": "2024-07-31T12:00:00Z",
"url": {
"relative": "/projects/project-title",
"url": "https://example.com/projects/project-title"
}
}
],
"metadata": {
"count": 1,
"offset": 0,
"total": 1,
"tooManyToCount": false,
"cursors": {
"next": "next_cursor",
"prev": "prev_cursor"
}
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.