List registrations

GET

registrations

List registrations

curl --request GET \
  --url https://api.oneofnone.io/v1/registrations \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "AWAITING_MINT",
      "email": "[email protected]",
      "phone": "<string>",
      "wallet_address": "<string>",
      "tx_url": "<string>",
      "short_url": "<string>",
      "token_id": 123,
      "metadata": {
        "firstName": "<string>",
        "lastName": "<string>",
        "postalCode": "<string>",
        "phoneNumber": "<string>"
      },
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<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>"
        },
        "quantity": 123
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "phone": "<string>",
        "metadata": {},
        "avatar": {
          "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>"
        },
        "app_id": 123,
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_login_at": "2023-11-07T05:31:56Z",
        "login_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "https://api.example.com/users?limit=20&offset=20",
    "prev": "https://api.example.com/users?limit=20&offset=0",
    "limit": 20,
    "offset": 0,
    "total_count": 150,
    "total_pages": 8,
    "current_page": 1
  }
}

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

string<email>

Filter registrations by email address.

collection_id

string<uuid>

Filter registrations by collection ID.

token_id

integer

Filter registrations by token ID.

Required range: x >= 1

wallet_address

string

Filter registrations by wallet address.

short_url

string

Filter registrations by short URL.

status

enum<string>

Filter registrations by status.

Available options:

AWAITING_MINT,

COMPLETE

min_created_at

string<date-time>

Filter registrations created after this date.

max_created_at

string<date-time>

Filter registrations created before this date.

limit

integer

default:1000

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

Required range: 1 <= x <= 1000

offset

integer

default:0

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

Required range: x >= 0

order

enum<string>

default:asc

The sort order of the results.

Available options:

asc,

desc

order_by

string

The field by which to order the results.

include_count

boolean

default:false

If true, returns additional pagination metadata including total count and total pages.

Response

Successfully retrieved registrations.

data

object[]

required

Show child attributes

data.id

string<uuid>

The unique identifier for the product registration.

data.status

enum<string>

The current status of the product registration.

Available options:

AWAITING_MINT,

COMPLETE

data.email

string<email>

The email address of the person who registered the product.

data.phone

string | null

The phone number of the person who registered the product.

data.wallet_address

string | null

The blockchain wallet address associated with the registration.

data.tx_url

string<uri> | null

The blockchain transaction URL for the registration if applicable.

data.short_url

string | null

The short URL used to initiate the registration.

data.token_id

integer | null

The unique token identifier for the registered product.

data.metadata

object

Additional metadata collected during registration including personal information and custom fields.

Show child attributes

data.metadata.firstName

string | null

The registrant's first name.

data.metadata.lastName

string | null

The registrant's last name.

data.metadata.postalCode

string | null

The registrant's postal code.

data.metadata.phoneNumber

string | null

The registrant's phone number.

data.collection_id

string<uuid> | null

The unique identifier of the collection the registered product belongs to.

data.collection

object

Information about the collection the registered product belongs to.

Show child attributes

data.collection.id

string<uuid>

The unique identifier of the collection.

data.collection.name

string

The name of the collection.

data.collection.slug

string | null

The URL-friendly slug of the collection.

data.collection.image

object

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

Show child attributes

data.collection.image.alt

string | null

Alternative text for the media.

data.collection.image.created_at

string<date-time>

The creation timestamp of the media.

data.collection.image.description

string | null

Description of the media.

data.collection.image.file_type

string | null

The file type of the media.

data.collection.image.id

integer

The unique identifier for the media.

data.collection.image.poster_url

string<uri> | null

URL to the poster of the media.

data.collection.image.size

integer | null

The size of the media in bytes.

data.collection.image.tags

string[] | null

Tags associated with the media.

data.collection.image.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.collection.image.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.collection.image.url

string<uri>

URL to the media.

data.collection.quantity

integer | null

The total quantity of items in the collection.

data.user

object

Information about the user who registered the product.

Show child attributes

data.user.id

string<uuid>

The unique identifier for the user.

data.user.email

string<email> | null

The user's email address.

data.user.phone

string | null

The user's phone number.

data.user.metadata

object

Additional user metadata and custom fields collected during registration or profile updates.

data.user.avatar

object

The user's profile avatar image. Note that only the url field is populated in user responses.

Show child attributes

data.user.avatar.alt

string | null

Alternative text for the media.

data.user.avatar.created_at

string<date-time>

The creation timestamp of the media.

data.user.avatar.description

string | null

Description of the media.

data.user.avatar.file_type

string | null

The file type of the media.

data.user.avatar.id

integer

The unique identifier for the media.

data.user.avatar.poster_url

string<uri> | null

URL to the poster of the media.

data.user.avatar.size

integer | null

The size of the media in bytes.

data.user.avatar.tags

string[] | null

Tags associated with the media.

data.user.avatar.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.user.avatar.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.user.avatar.url

string<uri>

URL to the media.

data.user.app_id

integer | null

The unique identifier of the app the user is associated with.

data.user.team_id

string<uuid> | null

The unique identifier of the team the user belongs to.

The timestamp of the user's last login.

The total number of times the user has logged in.

data.user.created_at

string<date-time>

The timestamp when the user account was created.

data.user.updated_at

string<date-time> | null

The timestamp when the user account was last updated.

data.created_at

string<date-time>

The timestamp when the registration was created.

data.updated_at

string<date-time> | null

The timestamp when the registration was last updated.

pagination

object

required

Show child attributes

pagination.next

string | null

required

URL for the next page of results, null if this is the last page

Example:

"https://api.example.com/users?limit=20&offset=20"

pagination.prev

string | null

required

URL for the previous page of results, null if this is the first page

Example:

"https://api.example.com/users?limit=20&offset=0"

pagination.limit

integer

required

The maximum number of items returned per page

Required range: 1 <= x <= 1000

Example:

20

pagination.offset

integer

required

The number of items skipped before the current page

Required range: x >= 0

Example:

0

pagination.total_count

integer

Total number of items available (only included when count is requested)

Required range: x >= 0

Example:

150

pagination.total_pages

integer

Total number of pages available (only included when count is requested)

Required range: x >= 0

Example:

8

pagination.current_page

integer

Current page number (only included when count is requested)

Required range: x >= 1

Example:

1

Get registrationFetches a single product registration by its unique identifier (ID), short URL, or collection slug. Use the `type` query parameter to specify whether to query by `ID`, `SHORT_URL`, or `SLUG`. When using `SLUG` type, a `token_id` must be provided.

⌘I

List registrations

curl --request GET \
  --url https://api.oneofnone.io/v1/registrations \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "AWAITING_MINT",
      "email": "[email protected]",
      "phone": "<string>",
      "wallet_address": "<string>",
      "tx_url": "<string>",
      "short_url": "<string>",
      "token_id": 123,
      "metadata": {
        "firstName": "<string>",
        "lastName": "<string>",
        "postalCode": "<string>",
        "phoneNumber": "<string>"
      },
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<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>"
        },
        "quantity": 123
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "phone": "<string>",
        "metadata": {},
        "avatar": {
          "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>"
        },
        "app_id": 123,
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_login_at": "2023-11-07T05:31:56Z",
        "login_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "https://api.example.com/users?limit=20&offset=20",
    "prev": "https://api.example.com/users?limit=20&offset=0",
    "limit": 20,
    "offset": 0,
    "total_count": 150,
    "total_pages": 8,
    "current_page": 1
  }
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Authorizations

Query Parameters

Response