GET
/
v1
/
collections
/
{id}

Authorizations

x-api-key
string
headerrequired

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Path Parameters

id
string
required

The ID or slug of the collection.

Query Parameters

type
enum<string>

Specify whether to query by collection ID or SLUG. Defaults to SLUG if not provided.

Available options:
ID,
SLUG

Response

200 - application/json
id
integer

The unique identifier of the collection.

name
string

The name of the collection.

type
string | null

The type of the collection.

description
string | null

The description of the collection.

quantity
integer | null

The quantity of items in the collection.

status
enum<string> | null

The status of the collection.

Available options:
ACTIVE,
DRAFT,
PENDING_APPROVAL,
ARCHIVED
slug
string | null

The slug of the collection.

keywords
string[] | null

Keywords associated with the collection.

redirect_url
string | null

Redirect URL for the collection.

store_url
string | null

Store URL for the collection.

purchase_url
string | null

Purchase URL for the collection.

image
object
video
object | null
model
object | null
share_image
object | null
gallery
object[] | null

The gallery items related to the collection.

chain
enum<string> | null

The blockchain chain of the collection.

Available options:
ETH,
POLY,
BASE,
ETH_SEPOLIA,
BASE_SEPOLIA,
POLY_AMOY,
OP
contract
object | null
product_registration
boolean | null

Indicates whether product registration is required.

product_name_template
string | null

Template for the product name.

drop_date
string | null

The drop date of the collection.

drop_price
number | null

The drop price of the collection.

drop_currency
enum<string> | null

The currency used for the drop price.

Available options:
ETH,
USD,
USDC,
EUR,
GBP,
MATIC,
SOL
attributes
object | null

Additional attributes of the collection.

variants
object | null

Variants of the collection.

created_at
string

The timestamp when the collection was created.

updated_at
string | null

The timestamp when the collection was last updated.