GET
/
v1
/
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": "jsmith@example.com",
      "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": "jsmith@example.com",
        "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

​
email
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
​
pagination
object
required