Get collection list

Authorizations

x-api-key

string

header

required

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

Query Parameters

status

enum<string>

The status of the collections to filter by.

Available options:

ACTIVE,

DRAFT,

INACTIVE

chain

enum<string>

The blockchain to filter collections by.

Available options:

ETH,

POLY,

BASE

min_quantity

integer

The minimum number of products in the collection.

Required range: x > 1

max_quantity

integer

The maximum number of products in the collection.

Required range: x > 1

min_drop_price

number

The minimum price for products in the collection.

Required range: x > 1

max_drop_price

number

The maximum price for products in the collection.

Required range: x > 1

limit

integer

The maximum number of items to return (1-1000).

Required range: 1 < x < 1000

offset

integer

The number of items to skip before starting to collect the result set.

order

enum<string>

The sort order of the results.

Available options:

asc,

desc

order_by

string

The field by which to order the results.

Response

200 - application/json

data

object[]

data.attributes

object | null

Additional attributes of the collection.

data.chain

enum<string> | null

The blockchain chain of the collection.

Available options:

ETH,

POLY,

BASE,

ETH_SEPOLIA,

BASE_SEPOLIA,

POLY_AMOY,

OP

data.contract

object | null

data.created_at

string

The timestamp when the collection was created.

data.description

string | null

The description of the collection.

data.drop_currency

enum<string> | null

The currency used for the drop price.

Available options:

ETH,

USD,

USDC,

EUR,

GBP,

MATIC,

SOL

data.drop_date

string | null

The drop date of the collection.

data.drop_price

number | null

The drop price of the collection.

data.gallery

object[] | null

The gallery items related to the collection.

data.id

integer

The unique identifier of the collection.

data.image

object

data.keywords

string[] | null

Keywords associated with the collection.

data.model

object | null

data.name

string

The name of the collection.

data.product_name_template

string | null

Template for the product name.

data.product_registration

boolean | null

Indicates whether product registration is required.

data.purchase_url

string | null

Purchase URL for the collection.

data.quantity

integer | null

The quantity of items in the collection.

data.redirect_url

string | null

Redirect URL for the collection.

data.slug

string | null

The slug of the collection.

data.status

enum<string> | null

The status of the collection.

Available options:

ACTIVE,

DRAFT,

PENDING_APPROVAL,

ARCHIVED

data.store_url

string | null

Store URL for the collection.

data.type

string | null

The type of the collection.

data.updated_at

string | null

The timestamp when the collection was last updated.

data.variants

object | null

Variants of the collection.

data.video

object | null

pagination

object

Access

Activities

Analytics

Collections

Products

Metadata

Authorizations

Query Parameters

Response