List collection blocks

GET

collections

{id}

blocks

curl --request GET \
  --url https://api.oneofnone.io/v1/collections/{id}/blocks \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "blocks": [
        {
          "block": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "title": "<string>",
            "description": "<string>",
            "status": "ACTIVE",
            "target_size": "2x1",
            "type": "text",
            "action_type": "url",
            "url": "<string>",
            "visibility": "public",
            "tags": [
              "<string>"
            ],
            "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "style": {
              "color": "<string>",
              "font_size": "<string>",
              "line_height": "<string>",
              "background_color": "<string>",
              "overlay_color": "<string>",
              "padding_top": "<string>",
              "padding_right": "<string>",
              "padding_bottom": "<string>",
              "padding_left": "<string>",
              "border_width": "<string>",
              "border_color": "<string>",
              "border_radius": "<string>"
            },
            "card": {
              "class_name": "<string>",
              "header": {
                "text": "<string>",
                "element": "h2",
                "color": "<string>",
                "font_size": "<string>",
                "line_height": "<string>",
                "text_align": "left",
                "uppercase": true,
                "class_name": "<string>"
              },
              "footer": {
                "text": "<string>",
                "element": "h2",
                "color": "<string>",
                "font_size": "<string>",
                "line_height": "<string>",
                "text_align": "left",
                "uppercase": true,
                "class_name": "<string>"
              },
              "body": {
                "class_name": "<string>",
                "align_vertical": "top",
                "align_horizontal": "left",
                "content": "<string>"
              }
            },
            "dialog": {
              "class_name": "<string>",
              "carousel_style": 1,
              "carousel_cta": {
                "text": "<string>",
                "text_class_name": "<string>",
                "button_label": "<string>",
                "button_href": "<string>",
                "button_class_name": "<string>",
                "class_name": "<string>"
              },
              "caption": "<string>",
              "youtube": true,
              "post_title": "<string>",
              "post_body": "<string>",
              "post_date": "<string>",
              "post_date_format": "<string>",
              "iframe_url": "<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>"
            },
            "background_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>"
            },
            "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>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "order": 1
        }
      ]
    }
  ],
  "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.

Path Parameters

string<uuid>

required

The unique identifier of the collection.

Query Parameters

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 collection blocks.

data

object[]

required

Show child attributes

data.id

string<uuid>

required

data.collection_id

string<uuid>

required

data.blocks

object[]

required

Show child attributes

data.blocks.block

object

required

Show child attributes

data.blocks.block.id

string<uuid>

The unique identifier for the block.

data.blocks.block.slug

string | null

The URL-friendly slug for the block.

data.blocks.block.title

string | null

The title of the block.

data.blocks.block.description

string | null

The description of the block.

data.blocks.block.status

enum<string> | null

The current status of the block.

Available options:

ACTIVE,

DRAFT,

ARCHIVED

data.blocks.block.target_size

enum<string> | null

The target size dimensions for the block layout.

Available options:

2x1,

1x1,

1x2

data.blocks.block.type

enum<string> | null

The type of content displayed in the block.

Available options:

text,

image,

text-image,

image-text,

placeholder

data.blocks.block.action_type

enum<string> | null

The type of action that occurs when the block is interacted with.

Available options:

url,

carousel,

image,

video,

post,

iframe,

registration

data.blocks.block.url

string<uri> | null

The URL associated with the block action.

data.blocks.block.visibility

enum<string> | null

The visibility level of the block.

Available options:

public,

collection,

owner

data.blocks.block.tags

string[] | null

Tags associated with the block for categorization.

data.blocks.block.owner_id

string<uuid> | null

The unique identifier of the block owner.

data.blocks.block.team_id

string<uuid> | null

The unique identifier of the team that owns the block.

data.blocks.block.style

object

Custom styling configuration for the block.

Show child attributes

data.blocks.block.style.color

string | null

Default text color for the block (applies to body, header, footer).

data.blocks.block.style.font_size

Default font size for the block (applies to body, header, footer).

data.blocks.block.style.line_height

Default line height for the block (applies to body, header, footer).

data.blocks.block.style.background_color

string | null

Background color for the block.

data.blocks.block.style.overlay_color

string | null

Overlay color for the block.

data.blocks.block.style.padding_top

Padding top for the block.

data.blocks.block.style.padding_right

Padding right for the block.

data.blocks.block.style.padding_bottom

Padding bottom for the block.

data.blocks.block.style.padding_left

Padding left for the block.

data.blocks.block.style.border_width

Border width for the block.

data.blocks.block.style.border_color

string | null

Border color for the block.

data.blocks.block.style.border_radius

Border radius for the block.

data.blocks.block.card

object

Card layout and content configuration for the block.

Show child attributes

data.blocks.block.card.class_name

string | null

CSS class name for the card container.

data.blocks.block.card.header

object

Header configuration for the card.

Show child attributes

data.blocks.block.card.header.text

string | null

Heading text.

data.blocks.block.card.header.element

enum<string> | null

Heading element type (default h4).

Available options:

h2,

h3,

h4,

h5,

h6,

div

data.blocks.block.card.header.color

string | null

Heading color. Defaults to the foreground variable.

data.blocks.block.card.header.font_size

Heading font size.

data.blocks.block.card.header.line_height

Heading line height.

data.blocks.block.card.header.text_align

enum<string> | null

Heading text alignment.

Available options:

left,

center,

right

data.blocks.block.card.header.uppercase

boolean | null

Whether the heading text should be uppercase.

data.blocks.block.card.header.class_name

string | null

Custom class name selector for the heading element.

data.blocks.block.card.footer

object

Footer configuration for the card.

Show child attributes

data.blocks.block.card.footer.text

string | null

Heading text.

data.blocks.block.card.footer.element

enum<string> | null

Heading element type (default h4).

Available options:

h2,

h3,

h4,

h5,

h6,

div

data.blocks.block.card.footer.color

string | null

Heading color. Defaults to the foreground variable.

data.blocks.block.card.footer.font_size

Heading font size.

data.blocks.block.card.footer.line_height

Heading line height.

data.blocks.block.card.footer.text_align

enum<string> | null

Heading text alignment.

Available options:

left,

center,

right

data.blocks.block.card.footer.uppercase

boolean | null

Whether the heading text should be uppercase.

data.blocks.block.card.footer.class_name

string | null

Custom class name selector for the heading element.

data.blocks.block.card.body

object

Show child attributes

data.blocks.block.card.body.class_name

string | null

CSS class name for the card body.

data.blocks.block.card.body.align_vertical

enum<string> | null

Vertical alignment of the card body content.

Available options:

top,

center,

bottom

data.blocks.block.card.body.align_horizontal

enum<string> | null

Horizontal alignment of the card body content.

Available options:

left,

center,

right

data.blocks.block.card.body.content

string | null

The main content text for the card body.

data.blocks.block.dialog

object

Dialog configuration for interactive block behaviors.

Show child attributes

data.blocks.block.dialog.class_name

string | null

CSS class name for the dialog container.

data.blocks.block.dialog.carousel_style

enum<integer> | null

Style variation for carousel dialog type.

Available options:

1,

2

data.blocks.block.dialog.carousel_cta

object

Call-to-action configuration for carousel dialogs.

Show child attributes

data.blocks.block.dialog.carousel_cta.text

string | null

Call-to-action text.

data.blocks.block.dialog.carousel_cta.text_class_name

string | null

CSS class for the CTA text.

data.blocks.block.dialog.carousel_cta.button_label

string | null

Label for the CTA button.

data.blocks.block.dialog.carousel_cta.button_href

string<uri> | null

URL for the CTA button.

data.blocks.block.dialog.carousel_cta.button_class_name

string | null

CSS class for the CTA button.

data.blocks.block.dialog.carousel_cta.class_name

string | null

CSS class for the CTA container.

data.blocks.block.dialog.caption

string | null

Caption text for image dialogs.

data.blocks.block.dialog.youtube

boolean | null

Whether the video is from YouTube for video dialogs.

data.blocks.block.dialog.post_title

string | null

Title for post dialogs.

data.blocks.block.dialog.post_body

string | null

Body content for post dialogs.

data.blocks.block.dialog.post_date

string | null

Date string for post dialogs.

data.blocks.block.dialog.post_date_format

string | null

Date format specification for post dialogs.

data.blocks.block.dialog.iframe_url

string<uri> | null

URL for iframe dialogs.

data.blocks.block.image

object

The primary image media for the block. Note that id, url, alt, style, and file_type fields are populated in block responses.

Show child attributes

data.blocks.block.image.alt

string | null

Alternative text for the media.

data.blocks.block.image.created_at

string<date-time>

The creation timestamp of the media.

data.blocks.block.image.description

string | null

Description of the media.

data.blocks.block.image.file_type

string | null

The file type of the media.

data.blocks.block.image.id

integer

The unique identifier for the media.

data.blocks.block.image.poster_url

string<uri> | null

URL to the poster of the media.

data.blocks.block.image.size

integer | null

The size of the media in bytes.

data.blocks.block.image.tags

string[] | null

Tags associated with the media.

data.blocks.block.image.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.blocks.block.image.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.blocks.block.image.url

string<uri>

URL to the media.

data.blocks.block.background_image

object

The background image media for the block. Note that id, url, alt, style, and file_type fields are populated in block responses.

Show child attributes

data.blocks.block.background_image.alt

string | null

Alternative text for the media.

data.blocks.block.background_image.created_at

string<date-time>

The creation timestamp of the media.

data.blocks.block.background_image.description

string | null

Description of the media.

data.blocks.block.background_image.file_type

string | null

The file type of the media.

data.blocks.block.background_image.id

integer

The unique identifier for the media.

data.blocks.block.background_image.poster_url

string<uri> | null

URL to the poster of the media.

data.blocks.block.background_image.size

integer | null

The size of the media in bytes.

data.blocks.block.background_image.tags

string[] | null

Tags associated with the media.

data.blocks.block.background_image.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.blocks.block.background_image.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.blocks.block.background_image.url

string<uri>

URL to the media.

data.blocks.block.video

object

The video media for the block. Note that only url, poster_url, and file_type fields are populated in block responses.

Show child attributes

data.blocks.block.video.alt

string | null

Alternative text for the media.

data.blocks.block.video.created_at

string<date-time>

The creation timestamp of the media.

data.blocks.block.video.description

string | null

Description of the media.

data.blocks.block.video.file_type

string | null

The file type of the media.

data.blocks.block.video.id

integer

The unique identifier for the media.

data.blocks.block.video.poster_url

string<uri> | null

URL to the poster of the media.

data.blocks.block.video.size

integer | null

The size of the media in bytes.

data.blocks.block.video.tags

string[] | null

Tags associated with the media.

data.blocks.block.video.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.blocks.block.video.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.blocks.block.video.url

string<uri>

URL to the media.

data.blocks.block.gallery

object[] | null

The gallery items related to the block. Note that only id, url, file_type, poster_url, and order fields are populated in block responses.

Show child attributes

data.blocks.block.gallery.alt

string | null

Alternative text for the media.

data.blocks.block.gallery.created_at

string<date-time>

The creation timestamp of the media.

data.blocks.block.gallery.description

string | null

Description of the media.

data.blocks.block.gallery.file_type

string | null

The file type of the media.

data.blocks.block.gallery.id

integer

The unique identifier for the media.

data.blocks.block.gallery.poster_url

string<uri> | null

URL to the poster of the media.

data.blocks.block.gallery.size

integer | null

The size of the media in bytes.

data.blocks.block.gallery.tags

string[]

Tags associated with the media. Variants of the gallery item.

data.blocks.block.gallery.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.blocks.block.gallery.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.blocks.block.gallery.url

string<uri>

URL to the media.

data.blocks.block.gallery.order

integer | null

Order of the gallery item.

data.blocks.block.gallery.variants

(string | null)[]

Variants of the gallery item.

data.blocks.block.gallery.type

string | null

Type of the gallery item.

data.blocks.block.gallery.caption

string | null

Caption of the gallery item.

data.blocks.block.created_at

string<date-time>

The timestamp when the block was created.

data.blocks.block.updated_at

string<date-time> | null

The timestamp when the block was last updated.

data.blocks.order

integer

required

Required range: x >= 0

pagination

object

required

Show child attributes

pagination.next

string | null

required

URL for the next page of results, null if this is the last page

Example:

"https://api.example.com/users?limit=20&offset=20"

pagination.prev

string | null

required

URL for the previous page of results, null if this is the first page

Example:

"https://api.example.com/users?limit=20&offset=0"

pagination.limit

integer

required

The maximum number of items returned per page

Required range: 1 <= x <= 1000

Example:

20

pagination.offset

integer

required

The number of items skipped before the current page

Required range: x >= 0

Example:

0

pagination.total_count

integer

Total number of items available (only included when count is requested)

Required range: x >= 0

Example:

150

pagination.total_pages

integer

Total number of pages available (only included when count is requested)

Required range: x >= 0

Example:

8

pagination.current_page

integer

Current page number (only included when count is requested)

Required range: x >= 1

Example:

1

Get collection metadataRetrieves metadata for a collection by its slug. This endpoint is publicly accessible and returns basic collection information including name, description, and image URL.

⌘I

List collection blocks

curl --request GET \
  --url https://api.oneofnone.io/v1/collections/{id}/blocks \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "blocks": [
        {
          "block": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "title": "<string>",
            "description": "<string>",
            "status": "ACTIVE",
            "target_size": "2x1",
            "type": "text",
            "action_type": "url",
            "url": "<string>",
            "visibility": "public",
            "tags": [
              "<string>"
            ],
            "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "style": {
              "color": "<string>",
              "font_size": "<string>",
              "line_height": "<string>",
              "background_color": "<string>",
              "overlay_color": "<string>",
              "padding_top": "<string>",
              "padding_right": "<string>",
              "padding_bottom": "<string>",
              "padding_left": "<string>",
              "border_width": "<string>",
              "border_color": "<string>",
              "border_radius": "<string>"
            },
            "card": {
              "class_name": "<string>",
              "header": {
                "text": "<string>",
                "element": "h2",
                "color": "<string>",
                "font_size": "<string>",
                "line_height": "<string>",
                "text_align": "left",
                "uppercase": true,
                "class_name": "<string>"
              },
              "footer": {
                "text": "<string>",
                "element": "h2",
                "color": "<string>",
                "font_size": "<string>",
                "line_height": "<string>",
                "text_align": "left",
                "uppercase": true,
                "class_name": "<string>"
              },
              "body": {
                "class_name": "<string>",
                "align_vertical": "top",
                "align_horizontal": "left",
                "content": "<string>"
              }
            },
            "dialog": {
              "class_name": "<string>",
              "carousel_style": 1,
              "carousel_cta": {
                "text": "<string>",
                "text_class_name": "<string>",
                "button_label": "<string>",
                "button_href": "<string>",
                "button_class_name": "<string>",
                "class_name": "<string>"
              },
              "caption": "<string>",
              "youtube": true,
              "post_title": "<string>",
              "post_body": "<string>",
              "post_date": "<string>",
              "post_date_format": "<string>",
              "iframe_url": "<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>"
            },
            "background_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>"
            },
            "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>"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "order": 1
        }
      ]
    }
  ],
  "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
  }
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Authorizations

Path Parameters

Query Parameters

Response