Getting Started
Access API
Analytics API
Collections API
Registrations API
Short URLs API
List collections
Fetches a list of collections with optional filters such as status, blockchain, and quantity. Results can be paginated and ordered by various fields. The endpoint supports filtering by collection status, blockchain chain, and quantity range.
curl --request GET \
--url https://api.oneofnone.io/v1/collections \
--header 'x-api-key: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"quantity": 123,
"status": "ACTIVE",
"slug": "<string>",
"keywords": [
"<string>"
],
"redirect_type": "profile",
"redirect_url": "<string>",
"registration_type": "NONE",
"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>"
}
},
"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>"
},
"video": {
"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>"
},
"model": {
"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>"
},
"share_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>"
},
"gallery": [
{
"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>",
"order": 123,
"variants": [
"<string>"
],
"type": "<string>",
"caption": "<string>"
}
],
"chain": "ETH",
"contract": {
"address": "<string>",
"standard": "<string>"
},
"product_name_template": "<string>",
"retail_settings": {},
"launch_date": "2023-11-07T05:31:56Z",
"attributes": {},
"variants": {},
"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 collections by their status.
ACTIVE, DRAFT, INACTIVE Filter collections by their blockchain chain.
ETH, POLY, BASE Filter collections by minimum quantity of products.
x >= 1Filter collections by maximum quantity of products.
x >= 1The 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 collections.
Show child attributes
Show child attributes
The unique identifier of the collection.
The name of the collection.
The type of the collection.
The description of the collection.
The quantity of items in the collection.
The status of the collection.
ACTIVE, DRAFT, PENDING_APPROVAL, ARCHIVED The URL-friendly slug of the collection.
Keywords associated with the collection for search and categorization.
The type of redirect for the collection.
profile, url The URL to redirect to when the collection is accessed.
The type of registration system used for this collection.
NONE, SHOPIFY, BLOCKCHAIN, EMAIL Configuration settings for the registration system including trigger button, auth screen, form fields, and success screen settings.
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.
The primary image for the collection. Note that only the url field is populated in collection 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 video media for the collection. Note that only url and poster_url fields are populated in collection 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 3D model media for the collection. Note that only the url field is populated in collection 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 social sharing image for the collection. Note that only the url field is populated in collection 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 gallery items related to the collection. Note that url, file_type, poster_url, order, tags, and variants fields are populated in collection 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. Variants of the gallery item. Tags associated with this gallery item.
URL to the thumbnail of the media.
The last updated timestamp of the media.
URL to the media.
Order of the gallery item.
Variants of the gallery item. Variants associated with this gallery item.
Type of the gallery item.
Caption of the gallery item.
The blockchain chain of the collection.
ETH, POLY, BASE, ETH_SEPOLIA, BASE_SEPOLIA, POLY_AMOY, OP Template string used to generate individual product names within the collection.
Retail configuration including pricing, currency, sales channels, and POS system integration settings.
The planned or actual launch date of the collection.
Product attributes configuration defining the characteristics and properties that can be assigned to products in this collection.
Product variants configuration defining the different options (like size, color) available for products in this collection.
The timestamp when the collection was created.
The timestamp when the collection 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/collections \
--header 'x-api-key: <api-key>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"quantity": 123,
"status": "ACTIVE",
"slug": "<string>",
"keywords": [
"<string>"
],
"redirect_type": "profile",
"redirect_url": "<string>",
"registration_type": "NONE",
"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>"
}
},
"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>"
},
"video": {
"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>"
},
"model": {
"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>"
},
"share_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>"
},
"gallery": [
{
"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>",
"order": 123,
"variants": [
"<string>"
],
"type": "<string>",
"caption": "<string>"
}
],
"chain": "ETH",
"contract": {
"address": "<string>",
"standard": "<string>"
},
"product_name_template": "<string>",
"retail_settings": {},
"launch_date": "2023-11-07T05:31:56Z",
"attributes": {},
"variants": {},
"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
}
}