GET
/
v1
/
collections
/
{id}
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

200
application/json

Successfully retrieved collection.

The response is of type object.