GET
/
v1
/
products
curl --request GET \
  --url https://api.oneofnone.io/v1/products \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "attributes": {},
      "collection_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "grade": 123,
      "id": 123,
      "image": {
        "url": "<string>"
      },
      "is_vaulted": true,
      "name": "<string>",
      "registered_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "status": "<string>",
      "token_id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "video": {
        "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>"
        }
      ]
    }
  ],
  "pagination": {
    "next": "<string>",
    "prev": "<string>",
    "limit": 123,
    "offset": 123
  }
}

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

name
string

Filter products by name.

status
enum<string>

Filter products by status.

Available options:
ACTIVE,
DRAFT,
INACTIVE
grade
integer

Filter products by grade (1-10).

Required range: 1 <= x <= 10
min_registered_at
string

Filter products registered after the specified date.

max_registered_at
string

Filter products registered before the specified date.

is_vaulted
boolean

Filter products by vaulted status.

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
Successfully retrieved the list of products.
data
object[]

List of products.

pagination
object