Getting Started
Access API
Analytics API
Collections API
Registrations API
Short URLs API
List short URLs
Fetches a list of short URLs with optional filtering and pagination. Short URLs can be filtered by collection, token, title, destination URL, creation/update dates, and tap count. Collection information can be included in the response if requested.
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>",
"label": "<string>",
"required": true
}
]
},
"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
The API key required for accessing protected routes. It should be included in the request headers as x-api-key.
Query Parameters
Filter short URLs by collection ID.
Filter short URLs by token ID.
x >= 1Filter short URLs by title.
Filter short URLs by destination URL.
Filter short URLs created after this date.
Filter short URLs created before this date.
Filter short URLs updated after this date.
Filter short URLs updated before this date.
Filter short URLs with tap count greater than or equal to this value.
x >= 1Filter short URLs with tap count less than or equal to this value.
x >= 1Include collection information in the response.
The maximum number of items to return (1-1000).
1 <= x <= 1000The number of items to skip before starting to collect the result set.
x >= 0The sort order of the results.
asc, desc The field by which to order the results.
If true, returns additional pagination metadata including total count and total pages.
Response
Successfully retrieved short URLs.
Show child attributes
Show child attributes
The unique identifier for the short URL.
The actual short URL that redirects to the destination.
The unique identifier of the collection this short URL is associated with.
The unique token identifier for the specific product this short URL points to.
The title or name of the short URL for identification purposes.
The QR code data or identifier associated with this short URL.
The final destination URL that users are redirected to when accessing the short URL.
Configuration settings for product registration if this short URL supports registration functionality.
Show child attributes
Show child attributes
Configuration for the initial trigger button that starts the registration process.
Show child attributes
Show child attributes
Whether the trigger button is active and should be displayed.
Label text for the trigger button when the product is not yet registered.
Label text for the trigger button when the product is already registered.
CSS class name for styling the trigger button.
Configuration for the authentication screen shown before registration.
Show child attributes
Show child attributes
Title text displayed on the authentication screen.
Message text displayed on the authentication screen.
URL of the image to display on the authentication screen.
Configuration for the registration form screen including fields and consents.
Show child attributes
Show child attributes
Title text displayed on the registration form screen.
Message text displayed on the registration form screen.
Configuration for which fields to capture during registration.
Show child attributes
Show child attributes
Whether to capture the user's first name during registration.
Whether to capture the user's last name during registration.
Whether to capture the user's postal code during registration.
Whether to capture the user's phone number during registration.
Array of consent items to capture during registration.
Show child attributes
Show child attributes
Unique identifier for the consent item.
Internal title of the consent used for data exports and management.
Label text for the agreement checkbox (e.g., "I agree to the Terms of Service").
Whether this consent is required for registration to proceed.
Configuration for the success screen shown after successful registration.
Show child attributes
Show child attributes
Title text for the success screen. Can use template variables {{email}}, {{firstName}}, {{lastName}} if they exist.
Message text for the success screen. Can use template variables {{email}}, {{firstName}}, {{lastName}} if they exist.
URL of the image to display on the success screen.
Configuration for the call-to-action button on the success screen.
Show child attributes
Show child attributes
Label text for the success button.
URL that the success button should navigate to.
CSS class name for styling the success button.
Optional discount code to display on the success screen for promotional purposes.
Additional metadata and custom fields associated with the short URL.
Information about the collection this short URL is associated with (included when requested via query parameter).
Show child attributes
Show child attributes
The unique identifier of the collection.
The name of the collection.
The URL-friendly slug of the collection.
The collection image. Note that only the url field is populated in short URL responses.
Show child attributes
Show child attributes
Alternative text for the media.
The creation timestamp of the media.
Description of the media.
The file type of the media.
The unique identifier for the media.
URL to the poster of the media.
The size of the media in bytes.
Tags associated with the media.
URL to the thumbnail of the media.
The last updated timestamp of the media.
URL to the media.
The timestamp when the short URL was created.
The timestamp when the short URL was last updated.
Show child attributes
Show child attributes
URL for the next page of results, null if this is the last page
"https://api.example.com/users?limit=20&offset=20"
URL for the previous page of results, null if this is the first page
"https://api.example.com/users?limit=20&offset=0"
The maximum number of items returned per page
1 <= x <= 100020
The number of items skipped before the current page
x >= 00
Total number of items available (only included when count is requested)
x >= 0150
Total number of pages available (only included when count is requested)
x >= 08
Current page number (only included when count is requested)
x >= 11
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>",
"label": "<string>",
"required": true
}
]
},
"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
}
}