Sign in
collections

Get collection by ID

Retrieve detailed information about a specific collection by its ID.

This endpoint returns all metadata for the collection, including its name and configuration.

**Use cases:**
- Displaying collection details in UI
- Validating collection existence before creating scenes
- Fetching collection metadata for integrations
get/api/v1/collections/{collectionId}

Path parameters

collectionIdstring required

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Response

Default Response

idstring required
isDefaultboolean
workspacestring required
creatorstring required
updaterstring
teamsstring[] required
createdstring date-time required
sortOrderstring
namestring required
updatedstring date-time required
isDeletedboolean
deletedAtnumber

Changes

No recorded changes to this endpoint across all 1 revision of this API.