Skip to main content
GET
Fetch a collection

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Path Parameters

collection_id
string<uuid>
required

Collection id.

Example:

"8e1a7f50-90ab-4cde-8012-3456789abcde"

Response

200 - application/json

The collection.

id
string<uuid>
required
contract
object
required
name
string | null
required
external_id
string | null
required
redirect_url
string<uri> | null
required

URL a tap on this collection's units redirects to. Unit- and product-level redirects take precedence over this value.

Example:

"https://brand.example/p"