GET
/
v1
/
collections
/
{id}
Get collection
curl --request GET \
  --url https://api.oneofnone.io/v1/collections/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "<string>",
  "description": "<string>",
  "quantity": 123,
  "status": "ACTIVE",
  "slug": "<string>",
  "keywords": [
    "<string>"
  ],
  "redirect_type": "profile",
  "redirect_url": "<string>",
  "registration_type": "NONE",
  "registration_settings": {
    "triggerButton": {
      "active": true,
      "unregisteredLabel": "<string>",
      "registeredLabel": "<string>",
      "className": "<string>"
    },
    "auth": {
      "title": "<string>",
      "message": "<string>",
      "image": "<string>"
    },
    "form": {
      "title": "<string>",
      "message": "<string>",
      "fields": {
        "firstName": true,
        "lastName": true,
        "postalCode": true,
        "phoneNumber": true
      },
      "consents": [
        {
          "id": "<string>",
          "title": "<string>",
          "required": true,
          "label": "<string>"
        }
      ]
    },
    "success": {
      "title": "<string>",
      "message": "<string>",
      "image": "<string>",
      "button": {
        "label": "<string>",
        "url": "<string>",
        "className": "<string>"
      },
      "discountCode": "<string>"
    }
  },
  "image": {
    "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>"
  },
  "video": {
    "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>"
  },
  "model": {
    "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>"
  },
  "share_image": {
    "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>"
  },
  "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>",
      "caption": "<string>"
    }
  ],
  "chain": "ETH",
  "contract": {
    "address": "<string>",
    "standard": "<string>"
  },
  "product_name_template": "<string>",
  "retail_settings": {},
  "launch_date": "2023-11-07T05:31:56Z",
  "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 to fetch.

Query Parameters

​
type
enum<string>
default:SLUG

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

Available options:
ID,
SLUG
​
token_id
integer

Optional token ID to include registration status in the response.

Required range: x >= 1

Response

Successfully retrieved collection.

​
id
string<uuid>

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 URL-friendly slug of the collection.

​
keywords
string[] | null

Keywords associated with the collection for search and categorization.

​
redirect_type
enum<string> | null

The type of redirect for the collection.

Available options:
profile,
url
​
redirect_url
string<uri> | null

The URL to redirect to when the collection is accessed.

​
registration_type
enum<string> | null

The type of registration system used for this collection.

Available options:
NONE,
SHOPIFY,
BLOCKCHAIN,
EMAIL
​
registration_settings
object

Configuration settings for the product registration system including UI screens, form fields, and user flow. Configuration settings for the registration system including trigger button, auth screen, form fields, and success screen settings.

​
image
object

The primary image for the collection. Note that only the url field is populated in collection responses.

​
video
object

The video media for the collection. Note that only url and poster_url fields are populated in collection responses.

​
model
object

The 3D model media for the collection. Note that only the url field is populated in collection responses.

​
share_image
object

The social sharing image for the collection. Note that only the url field is populated in collection responses.

​
gallery
object[] | null

The gallery items related to the collection. Note that url, file_type, poster_url, order, tags, and variants fields are populated in collection responses.

​
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

Blockchain contract information for the collection.

​
product_name_template
string | null

Template string used to generate individual product names within the collection.

​
retail_settings
object | null

Retail configuration including pricing, currency, sales channels, and POS system integration settings.

​
launch_date
string<date-time> | null

The planned or actual launch date of the collection.

​
attributes
object | null

Product attributes configuration defining the characteristics and properties that can be assigned to products in this collection.

​
variants
object | null

Product variants configuration defining the different options (like size, color) available for products in this collection.

​
created_at
string<date-time>

The timestamp when the collection was created.

​
updated_at
string<date-time> | null

The timestamp when the collection was last updated.