Get registration

GET

registrations

{id}

Get registration

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

{
  "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"
}

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

string

required

The ID, short URL, or collection slug of the registration to fetch.

Query Parameters

type

enum<string>

default:ID

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

Available options:

ID,

SHORT_URL,

SLUG

token_id

integer

Required when type is SLUG. Optional for other types to filter by token ID.

Required range: x >= 1

Response

Successfully retrieved registration.

A product registration record containing customer information, product details, and collection association.

string<uuid>

The unique identifier for the product registration.

status

enum<string>

The current status of the product registration.

Available options:

AWAITING_MINT,

COMPLETE

string<email>

The email address of the person who registered the product.

phone

string | null

The phone number of the person who registered the product.

wallet_address

string | null

The blockchain wallet address associated with the registration.

tx_url

string<uri> | null

The blockchain transaction URL for the registration if applicable.

short_url

string | null

The short URL used to initiate the registration.

token_id

integer | null

The unique token identifier for the registered product.

metadata

object

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

Show child attributes

metadata.firstName

string | null

The registrant's first name.

metadata.lastName

string | null

The registrant's last name.

metadata.postalCode

string | null

The registrant's postal code.

metadata.phoneNumber

string | null

The registrant's phone number.

collection_id

string<uuid> | null

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

collection

object

Information about the collection the registered product belongs to.

Show child attributes

collection.id

string<uuid>

The unique identifier of the collection.

collection.name

string

The name of the collection.

collection.slug

string | null

The URL-friendly slug of the collection.

collection.image

object

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

Show child attributes

collection.image.alt

string | null

Alternative text for the media.

collection.image.created_at

string<date-time>

The creation timestamp of the media.

collection.image.description

string | null

Description of the media.

collection.image.file_type

string | null

The file type of the media.

collection.image.id

integer

The unique identifier for the media.

collection.image.poster_url

string<uri> | null

URL to the poster of the media.

collection.image.size

integer | null

The size of the media in bytes.

collection.image.tags

string[] | null

Tags associated with the media.

collection.image.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

collection.image.updated_at

string<date-time> | null

The last updated timestamp of the media.

collection.image.url

string<uri>

URL to the media.

collection.quantity

integer | null

The total quantity of items in the collection.

user

object

Information about the user who registered the product.

Show child attributes

user.id

string<uuid>

The unique identifier for the user.

user.email

string<email> | null

The user's email address.

user.phone

string | null

The user's phone number.

user.metadata

object

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

user.avatar

object

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

Show child attributes

user.avatar.alt

string | null

Alternative text for the media.

user.avatar.created_at

string<date-time>

The creation timestamp of the media.

user.avatar.description

string | null

Description of the media.

user.avatar.file_type

string | null

The file type of the media.

user.avatar.id

integer

The unique identifier for the media.

user.avatar.poster_url

string<uri> | null

URL to the poster of the media.

user.avatar.size

integer | null

The size of the media in bytes.

user.avatar.tags

string[] | null

Tags associated with the media.

user.avatar.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

user.avatar.updated_at

string<date-time> | null

The last updated timestamp of the media.

user.avatar.url

string<uri>

URL to the media.

user.app_id

integer | null

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

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.

user.created_at

string<date-time>

The timestamp when the user account was created.

user.updated_at

string<date-time> | null

The timestamp when the user account was last updated.

created_at

string<date-time>

The timestamp when the registration was created.

updated_at

string<date-time> | null

The timestamp when the registration was last updated.

Create a wallet registrationCreates a new product registration using a wallet address. This endpoint is used to register a product using a blockchain wallet address. The registration can be associated with a specific collection and token ID.

⌘I

Get registration

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

{
  "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"
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Authorizations

Path Parameters

Query Parameters

Response