Skip to main content
GET
/
v1
/
access
/
registration-settings
Get registration settings
curl --request GET \
  --url https://api.oneofnone.io/v1/access/registration-settings \
  --header 'x-api-key: <api-key>'
{
  "url": "https://example.com/register/123",
  "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>"
    }
  }
}

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

​
token_id
integer
required

The token ID of the product.

Required range: x >= 1
​
collection_slug
string

The slug of the collection containing the product.

​
collection_id
string<uuid>

The UUID of the collection containing the product.

Response

Registration settings retrieved successfully.

​
url
string
required

The URL associated with the product registration.

Example:

"https://example.com/register/123"

​
registration_settings
object
required

Configuration settings for the product registration system including UI screens, form fields, and user flow.

⌘I