v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0189430445.4 KB
Collections

Read Collection

Read the details of a Collection given its ID. Does not fetch items in this Collection.

post/rest/api/v1/getcollection

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

idinteger required

The ID of the Collection to be retrieved.

withItemsboolean

Whether or not to include the Collection Items in this Collection. Only request if absolutely required, as this is expensive.

withHierarchyboolean

Whether or not to include the top level Collection in this Collection's hierarchy.

allowedDatasourcestring

The datasource allowed in the Collection returned.

Response

OK

trackingTokenstring

Use collection.trackingToken instead.