GET

Get Collection


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 collection.

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

Path Params
collectionIdstringRequired

ID of the collection to retrieve.

Query Params
includePageUrlboolean

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

Response Object
collectionCollection

The requested collection.

Get Collection
Request
cURL
curl -X GET \ 'https://www.wixapis.com/portfolio/v1/collections/123e4567-e89b-12d3-a456-426614174000?includePageUrl=true' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "collection": { "id": "123e4567-e89b-12d3-a456-426614174000", "revision": 1, "title": "Collection Title", "description": "Collection Description", "slug": "collection-title", "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": { "relativePath": "/projects/project-title", "url": "https://example.com/projects/project-title" }, "seoData": { "settings": { "keywords": [ { "isMain": true, "origin": "marketing-persona", "term": "Investment Management" } ], "preventAutoRedirect": false }, "tags": [ { "children": "Investment Experts Share Growth Strategies", "custom": false, "disabled": false, "type": "title" }, { "children": "", "custom": false, "disabled": false, "props": { "content": "Investment strategies explained by investment experts. Investment experts offer valuable insights for growth.", "name": "description" }, "type": "meta" } ] } } }
Errors

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

Did this help?