GET

List Collections


Developer Preview

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 all collections in a portfolio.

Permissions
Manage Portfolio
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/portfolio/v1/collections

Query Params
paging.limitintegerminimum 0maximum 100format int32

Maximum number of items to return in the results.


paging.cursorstringmaxLength 16000

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.


includePageUrlboolean

Whether to include the collection's page URL and relative path in the response. Default: false

Response Object
collectionsArray <Collection>

List of collections.


metadataMetadata

Paging metadata.

List Collections
Request
cURL
curl -X GET \ 'https://www.wixapis.com/portfolio/v1/collections' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \
Response
JSON
{ "collections": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "revision": 1, "title": "Collection Title 1", "description": "Description of collection 1.", "slug": "collection-title-1", "coverImage": { "imageInfo": { "id": "8c074c67-2926-4518-92ef-c79d7810b3a4" } } "hidden": false, "sortOrder": 1.0, "createdDate": "2024-07-31T12:00:00Z", "updatedDate": "2024-07-31T12:00:00Z", "url": { "relative": "/collections/collection-title-1", "url": "https://example.com/collections/collection-title-1" } }, { "id": "223e4567-e89b-12d3-a456-426614174000", "revision": 1, "title": "Collection Title 2", "description": "Description of collection 2.", "slug": "collection-title-2", "coverImage": { "imageInfo": { "id": "42460836-02b9-4640-8d47-2d9fe9aba7e4" } } "hidden": true, "sortOrder": 2.0, "createdDate": "2024-07-31T12:10:00Z", "updatedDate": "2024-07-31T12:10:00Z", "url": { "relative": "/collections/collection-title-2", "url": "https://example.com/collections/collection-title-2" } } ], "metadata": { "count": 2, "offset": 0, "total": 2, "tooManyToCount": false, "cursors": { "next": "next_cursor", "prev": "prev_cursor" } } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?