# Archive reward
Source: https://docs.oneofnone.io/api-reference/archive-reward

delete /v1/rewards/{id}



# Assign data row
Source: https://docs.oneofnone.io/api-reference/assign-data-row

post /v1/collections/{slug}/data/{rowId}/assign



# Batch update users
Source: https://docs.oneofnone.io/api-reference/batch-update-users

post /v1/users/batch-update



# Check ownership
Source: https://docs.oneofnone.io/api-reference/check-ownership

get /v1/access/owner



# Claim reward grant
Source: https://docs.oneofnone.io/api-reference/claim-reward-grant

post /v1/rewards/grants/{token}/claim



# Create an activity
Source: https://docs.oneofnone.io/api-reference/create-an-activity

post /v1/activities



# Create an email registration
Source: https://docs.oneofnone.io/api-reference/create-an-email-registration

post /v1/registrations/register-email



# Create OTP
Source: https://docs.oneofnone.io/api-reference/create-otp

post /v1/access/otp



# Create reward
Source: https://docs.oneofnone.io/api-reference/create-reward

post /v1/rewards



# Create webhook
Source: https://docs.oneofnone.io/api-reference/create-webhook

post /v1/team/webhooks



# Delete activity
Source: https://docs.oneofnone.io/api-reference/delete-activity

delete /v1/activities/{id}



# Delete data source
Source: https://docs.oneofnone.io/api-reference/delete-data-source

delete /v1/collections/{slug}/data/source



# Delete webhook
Source: https://docs.oneofnone.io/api-reference/delete-webhook

delete /v1/team/webhooks/{id}



# Export raw events
Source: https://docs.oneofnone.io/api-reference/export-raw-events

get /v1/analytics/export/raw-events



# Generate reward codes
Source: https://docs.oneofnone.io/api-reference/generate-reward-codes

post /v1/rewards/{id}/codes/generate



# Get analytics for a specific short URL
Source: https://docs.oneofnone.io/api-reference/get-analytics-for-a-specific-short-url

get /v1/analytics/taps/individual/{slug}



# Get block click analytics
Source: https://docs.oneofnone.io/api-reference/get-block-click-analytics

get /v1/analytics/blocks



# Get blocks breakdown
Source: https://docs.oneofnone.io/api-reference/get-blocks-breakdown

get /v1/analytics/blocks/breakdown



# Get collection
Source: https://docs.oneofnone.io/api-reference/get-collection

get /v1/collections/{id}



# Get collection data stats
Source: https://docs.oneofnone.io/api-reference/get-collection-data-stats

get /v1/collections/{slug}/data/stats



# Get data source
Source: https://docs.oneofnone.io/api-reference/get-data-source

get /v1/collections/{slug}/data/source



# Get domains
Source: https://docs.oneofnone.io/api-reference/get-domains

get /v1/team/domains



# Get encodings
Source: https://docs.oneofnone.io/api-reference/get-encodings

get /v1/team/encodings



# Get flow behavior
Source: https://docs.oneofnone.io/api-reference/get-flow-behavior

get /v1/analytics/flow/behavior



# Get funnel analysis
Source: https://docs.oneofnone.io/api-reference/get-funnel-analysis

get /v1/analytics/funnel/analysis



# Get inventory
Source: https://docs.oneofnone.io/api-reference/get-inventory

get /v1/team/inventory



# Get journey sessions
Source: https://docs.oneofnone.io/api-reference/get-journey-sessions

get /v1/analytics/journey/sessions



# Get journey user events
Source: https://docs.oneofnone.io/api-reference/get-journey-user-events

get /v1/analytics/journey/user-events



# Get layout
Source: https://docs.oneofnone.io/api-reference/get-layout

get /v1/layouts/{id}



# Get order
Source: https://docs.oneofnone.io/api-reference/get-order

get /v1/team/orders/{id}



# Get product registration analytics
Source: https://docs.oneofnone.io/api-reference/get-product-registration-analytics

get /v1/analytics/registrations



# Get referrer performance
Source: https://docs.oneofnone.io/api-reference/get-referrer-performance

get /v1/analytics/referrer/performance



# Get registration
Source: https://docs.oneofnone.io/api-reference/get-registration

get /v1/registrations/{id}



# Get registrations breakdown
Source: https://docs.oneofnone.io/api-reference/get-registrations-breakdown

get /v1/analytics/registrations/breakdown



# Get retention cohorts
Source: https://docs.oneofnone.io/api-reference/get-retention-cohorts

get /v1/analytics/retention/cohorts



# Get reward
Source: https://docs.oneofnone.io/api-reference/get-reward

get /v1/rewards/{id}



# Get short URL
Source: https://docs.oneofnone.io/api-reference/get-short-url

get /v1/short-urls/{id}



# Get summary KPIs
Source: https://docs.oneofnone.io/api-reference/get-summary-kpis

get /v1/analytics/summary/kpis



# Get taps analytics
Source: https://docs.oneofnone.io/api-reference/get-taps-analytics

get /v1/analytics/taps



# Get taps breakdown
Source: https://docs.oneofnone.io/api-reference/get-taps-breakdown

get /v1/analytics/taps/breakdown



# Get taps conversion
Source: https://docs.oneofnone.io/api-reference/get-taps-conversion

get /v1/analytics/taps/conversion



# Get team
Source: https://docs.oneofnone.io/api-reference/get-team

get /v1/team



# Get team app settings
Source: https://docs.oneofnone.io/api-reference/get-team-app-settings

get /v1/team/app-settings



# Get tokens analytics
Source: https://docs.oneofnone.io/api-reference/get-tokens-analytics

get /v1/analytics/tokens



# Get user
Source: https://docs.oneofnone.io/api-reference/get-user

get /v1/users/{id}



# Get vault analytics
Source: https://docs.oneofnone.io/api-reference/get-vault-analytics

get /v1/analytics/vault



# Get vault breakdown
Source: https://docs.oneofnone.io/api-reference/get-vault-breakdown

get /v1/analytics/vault/breakdown



# Issue reward grant
Source: https://docs.oneofnone.io/api-reference/issue-reward-grant

post /v1/rewards/{id}/grants



# List activities
Source: https://docs.oneofnone.io/api-reference/list-activities

get /v1/activities



# List collection data
Source: https://docs.oneofnone.io/api-reference/list-collection-data

get /v1/collections/{slug}/data



# List collections
Source: https://docs.oneofnone.io/api-reference/list-collections

get /v1/collections



# List form submissions
Source: https://docs.oneofnone.io/api-reference/list-form-submissions

get /v1/form-submissions



# List orders
Source: https://docs.oneofnone.io/api-reference/list-orders

get /v1/team/orders



# List owned products
Source: https://docs.oneofnone.io/api-reference/list-owned-products

get /v1/access/owner/products



# List registrations
Source: https://docs.oneofnone.io/api-reference/list-registrations

get /v1/registrations



# List reward codes
Source: https://docs.oneofnone.io/api-reference/list-reward-codes

get /v1/rewards/{id}/codes



# List reward redemptions
Source: https://docs.oneofnone.io/api-reference/list-reward-redemptions

get /v1/rewards/{id}/redemptions



# List rewards
Source: https://docs.oneofnone.io/api-reference/list-rewards

get /v1/rewards



# List short URLs
Source: https://docs.oneofnone.io/api-reference/list-short-urls

get /v1/short-urls



# List users
Source: https://docs.oneofnone.io/api-reference/list-users

get /v1/users



# List webhooks
Source: https://docs.oneofnone.io/api-reference/list-webhooks

get /v1/team/webhooks



# Lookup reward by code
Source: https://docs.oneofnone.io/api-reference/lookup-reward-by-code

get /v1/rewards/lookup



# Record reward redemption
Source: https://docs.oneofnone.io/api-reference/record-reward-redemption

post /v1/rewards/redeem



# Redeem reward code
Source: https://docs.oneofnone.io/api-reference/redeem-reward-code

post /v1/rewards/{id}/codes/{codeId}/redeem



# Reserve reward code
Source: https://docs.oneofnone.io/api-reference/reserve-reward-code

post /v1/rewards/{id}/codes/{codeId}/reserve



# Retry reward sync
Source: https://docs.oneofnone.io/api-reference/retry-reward-sync

post /v1/rewards/{id}/sync



# Revalidate all short URLs
Source: https://docs.oneofnone.io/api-reference/revalidate-all-short-urls

post /v1/short-urls/revalidate



# Revalidate short URL
Source: https://docs.oneofnone.io/api-reference/revalidate-short-url

post /v1/short-urls/{id}/revalidate



# Submit a form
Source: https://docs.oneofnone.io/api-reference/submit-a-form

post /v1/form-submissions



# Sync data source
Source: https://docs.oneofnone.io/api-reference/sync-data-source

post /v1/collections/{slug}/data/source/sync



# Unassign data row
Source: https://docs.oneofnone.io/api-reference/unassign-data-row

post /v1/collections/{slug}/data/{rowId}/unassign



# Update activity
Source: https://docs.oneofnone.io/api-reference/update-activity

patch /v1/activities/{id}



# Update collection redirect settings
Source: https://docs.oneofnone.io/api-reference/update-collection-redirect-settings

patch /v1/collections/{id}



# Update registration metadata
Source: https://docs.oneofnone.io/api-reference/update-registration-metadata

patch /v1/registrations/{id}



# Update reward
Source: https://docs.oneofnone.io/api-reference/update-reward

patch /v1/rewards/{id}



# Update short URL
Source: https://docs.oneofnone.io/api-reference/update-short-url

patch /v1/short-urls/{id}



# Update user
Source: https://docs.oneofnone.io/api-reference/update-user

patch /v1/users/{id}



# Upload data source
Source: https://docs.oneofnone.io/api-reference/upload-data-source

post /v1/collections/{slug}/data/source



# Upsert reward code external id
Source: https://docs.oneofnone.io/api-reference/upsert-reward-code-external-id

patch /v1/rewards/{id}/codes/{codeId}/external-id



# Verify OTP
Source: https://docs.oneofnone.io/api-reference/verify-otp

post /v1/access/otp/verify



# Quickstart
Source: https://docs.oneofnone.io/quickstart

This guide will walk you through the essential steps to get started with our API, from obtaining your API key to making your first request.

<Steps>
  <Step title="Obtain Your API Keys">
    To start using the One of None API, you need to obtain your API keys from the dashboard. **Only team owners and team admins** have access to the API keys management section. Follow the steps below:

    1. **Log in to your One of None dashboard.**
       * Go to [One of None Dashboard](https://cloud.oneofnone.io) and sign in with your credentials.

    2. **Navigate to the API Keys section.**
       * In the sidebar, select **Team Settings**, then click on **API Keys**.

    3. **Copy your API keys.**
       * You will find two types of API keys available:
         * **Client API Key:** Safe for client-side operations (e.g., web applications), can be exposed in the browser.
         * **Server API Key:** For server-side operations, must be kept secret and never exposed publicly.
       * Click the **copy icon** next to the key to copy it to your clipboard.

    <Warning>
      Always keep your **Server API Key** secure and never expose it in a browser or
      client environment. **If your Server API key is leaked, regenerate it
      immediately**.
    </Warning>
  </Step>

  <Step title="Add Whitelisted Domains">
    Before you can start making requests to the API, you need to whitelist the domains that will use your API keys. **Only team owners and team admins** have access to this section:

    1. **Add your domains.**
       * Enter the fully qualified domain name (e.g., `https://yourwebsite.com` or `http://localhost:<port>` for local development).
         <Tip>Use wildcard subdomains like `*.yourwebsite.com` if you need broader access.</Tip>

    2. **Save the changes.**
       * Click the **"Save"** button to apply the changes.

    <Warning>Only requests originating from the whitelisted domains will be allowed to use the client API key.</Warning>
  </Step>

  <Step title="Make Your First API Request">
    Once you have obtained your API key and whitelisted your domains, you're ready to make your first API request. Use the `x-api-key` header to authenticate your requests.

    <CodeGroup>
      ```bash cURL theme={null}
      curl -X GET "https://api.oneofnone.io/v1/products" \
           -H "x-api-key: YOUR_API_KEY"
      ```

      ```javascript Node.js theme={null}
      const fetch = require('node-fetch');

      async function fetchProducts() {
        const response = await fetch('https://api.oneofnone.io/v1/products', {
          headers: {
            'x-api-key': 'YOUR_API_KEY'
          }
        });
        const data = await response.json();
        console.log(data);
      }

      fetchProducts();
      ```

      ```python Python theme={null}
      import requests

      url = "https://api.oneofnone.io/v1/products"
      headers = {"x-api-key": "YOUR_API_KEY"}

      response = requests.get(url, headers=headers)
      print(response.json())
      ```
    </CodeGroup>

    Replace `YOUR_API_KEY` with your actual API key to authenticate the request. If everything is set up correctly, you'll receive a JSON response like the following:

    ```json theme={null}
      {
        "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": []
          }
        ],
        "pagination": {
          "next": "<string>",
          "prev": "<string>",
          "limit": 123,
          "offset": 123
        }
      }
    ```

    If you encounter any issues, refer to the [troubleshooting page](/troubleshooting).
  </Step>
</Steps>

## Explore More

Once you have successfully made your first request, you can explore other API endpoints by referring to our [API Documentation](/api-reference). Need help? Contact our support team at [support@oneofnone.io](mailto:support@oneofnone.io).


# Troubleshooting
Source: https://docs.oneofnone.io/troubleshooting

Having trouble getting started with our API? Don’t worry, we’re here to help. Here’s a list of common issues we’ve seen customers run into:

<AccordionGroup>
  <Accordion title="I'm getting an 'Unauthorized' error when making API requests">
    Ensure you have included the correct API key in your request headers.

    **Solution:** Add the API key to the request using the `x-api-key` header. For example, using `cURL`:

    ```bash theme={null}
    curl -X GET https://api.oneofnone.io/v1/your-endpoint \
      -H "x-api-key: YOUR_SERVER_API_KEY"
    ```

    Double-check that you're using the **Server API Key**, as client keys have limited permissions.
  </Accordion>

  <Accordion title="I can't access the API Keys page in the dashboard">
    Access to the API Keys page is restricted to team **owners** and **admins**. If you are not seeing this page, you may not have the necessary permissions.

    **Solution:** Contact an admin or owner of your team to grant you the appropriate role or provide the required API key.
  </Accordion>

  <Accordion title="I'm getting a '403 Forbidden' error">
    Your API requests may be blocked due to missing domain whitelisting.

    **Solution:** Go to the "Whitelisted Domains" section in the dashboard and ensure that the domain or IP you're sending requests from is added. Example domains:

    ```
    https://yourwebsite.com
    http://localhost:3000
    ```

    After adding, click the **Save** button and try again.
  </Accordion>
</AccordionGroup>

Couldn't find what you were looking for? Contact our support team at [support@oneofnone.io](mailto:support@oneofnone.io).