List collections
GET/v1/collections
Collections use the same rules as the website. A sound board is a collection with kind board. Limits are counted per kind: free accounts can hold 1 collection and 1 sound board; Pro accounts can hold up to 1,000 of each and create up to 60 per hour. A collection holds at most 500 tracks. A lapsed Pro account can view everything but can edit only one collection and one sound board until it resubscribes. Adding a CC BY-NC track to a commercial collection, or marking a collection with CC BY-NC tracks commercial, returns nc_commercial. Collection PATCH requires the current revision. Item edits, reorder, and adds accept an optional revision guard; deletion requires explicit confirmation. Archived collections are left out unless archived is include or only; archived_count reports how many exist. The kind parameter picks collection (the default), board, or all.
Needs an API key. Send it in the Authorization: Bearer header.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
archived optional | Query | string | One of: include, only |
kind optional | Query | string | One of: collection, board, all. Default: collection |
Responses
200OK.Schema CollectionList · Content: application/json
401The API key is missing, not valid, or revoked.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time. 429Over your plan's limit. Free accounts get 20 calls per minute and 300 calls per day. Pro accounts get 60 calls per minute and 20,000 calls per month (UTC). MCP and the API share one allowance per account. The Retry-After header gives the seconds to wait, up to 86,400, and the limit and reset_at fields in the body name the limit you hit and when it resets.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time.
{
"collections": [
{
"id": "example",
"name": "example",
"kind": "collection",
"commercial": true,
"revision": 1,
"read_only": true,
"created": "example",
"updated": "example",
"archived_at": "example",
"description": "example",
"credits_heading": "example",
"item_count": 0
}
],
"archived_count": 0,
"entitlements": {
"plan": "free",
"max_collections": 1,
"max_boards": 1,
"can_export_record": true
}
} Copy only. No request is sent from this page, so your key never goes into a web page. The samples read it from the UNCOMMON_EAR_API_KEY environment variable.