Skip to main content
GET
/
v1
/
short-urls
List short URLs
curl --request GET \
  --url https://api.oneofnone.io/v1/short-urls \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "token_id": 123,
      "title": "<string>",
      "qr_code": "<string>",
      "destination_url": "<string>",
      "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>"
        }
      },
      "metadata": {},
      "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>"
        }
      },
      "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

​
collection_id
string<uuid>

Filter short URLs by collection ID.

​
token_id
integer

Filter short URLs by token ID.

Required range: x >= 1
​
title
string

Filter short URLs by title.

​
destination_url
string<uri>

Filter short URLs by destination URL.

​
min_created_at
string<date-time>

Filter short URLs created after this date.

​
max_created_at
string<date-time>

Filter short URLs created before this date.

​
min_updated_at
string<date-time>

Filter short URLs updated after this date.

​
max_updated_at
string<date-time>

Filter short URLs updated before this date.

​
min_tap_count
integer

Filter short URLs with tap count greater than or equal to this value.

Required range: x >= 1
​
max_tap_count
integer

Filter short URLs with tap count less than or equal to this value.

Required range: x >= 1
​
include_collection
boolean
default:false

Include collection information in the response.

​
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 short URLs.

​
data
object[]
required
​
pagination
object
required