Skip to navigation
StorefrontCatalogueCollections

List Collections

View as Markdown

Lists the collections published to the channel.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number, starting at 1. Ignored when last_id and keyset are sent.

sizeintegerOptional1-50Defaults to 20
Records per page. Defaults to 20, capped at 50.
last_idstringOptionalformat: "uuid"

The last_id from the previous response. Send it with keyset to get the next page. Omit both for the first page.

keysetstringOptional

The keyset from the previous response. Send it with last_id. Copy it as it is; don’t build or change it.

Response

Successfully fetched collections
statusboolean

Always true on success.

messagestring

Human-readable outcome.

countinteger
Records that match the request across all pages.
pagesinteger
Total pages at the requested size.
pageinteger

The page returned. 0 when the request used last_id and keyset.

keysetstring or null

Send back as keyset, with last_id, to get the next page. null when there are no more records.

last_idstring or nullformat: "uuid"

Send back as last_id, with keyset, to get the next page. null when there are no more records.

datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error