GET
/
v1
/
collections
/
{id}
curl --request GET \
  --url https://api.oneofnone.io/v1/collections/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "type": "<string>",
  "description": "<string>",
  "quantity": 123,
  "status": "ACTIVE",
  "slug": "<string>",
  "keywords": [
    "<string>"
  ],
  "redirect_url": "<string>",
  "store_url": "<string>",
  "purchase_url": "<string>",
  "image": {
    "url": "<string>"
  },
  "video": {
    "url": "<string>",
    "poster_url": "<string>"
  },
  "model": {
    "url": "<string>"
  },
  "share_image": {
    "url": "<string>"
  },
  "gallery": [
    {
      "alt": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "file_type": "<string>",
      "id": 123,
      "poster_url": "<string>",
      "size": 123,
      "tags": [
        "<string>"
      ],
      "thumbnail_url": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "order": 123,
      "variants": [
        "<string>"
      ],
      "type": "<string>"
    }
  ],
  "chain": "ETH",
  "contract": {
    "address": "<string>",
    "standard": "<string>"
  },
  "product_registration": true,
  "product_name_template": "<string>",
  "drop_date": "2023-11-07T05:31:56Z",
  "drop_price": 123,
  "drop_currency": "ETH",
  "attributes": {},
  "variants": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

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
Successfully retrieved collection.
​
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.