List activities

GET

activities

List activities

curl --request GET \
  --url https://api.oneofnone.io/v1/activities \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "type": "CREATOR",
      "title": "<string>",
      "content": "<string>",
      "json": {},
      "tx_url": "<string>",
      "location": "<string>",
      "owner_address": "<string>",
      "token_id": 123,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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"
    }
  ],
  "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

token_id

integer

The ID of the product (token) to fetch activities for.

Required range: x >= 1

collection_slug

string

The slug of the collection to fetch activities for.

min_date

string<date-time>

The minimum date for filtering activities.

max_date

string<date-time>

The maximum date for filtering activities.

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 activities.

data

object[]

required

Show child attributes

data.id

integer

The unique identifier for the activity.

data.type

enum<string>

The type of activity that occurred.

Available options:

CREATOR,

CUSTOMER,

BLOCKCHAIN,

SYSTEM

data.title

string | null

The title or headline for the activity.

data.content

string | null

The main content or description of the activity.

data.json

object

Additional structured data associated with the activity.

data.tx_url

string<uri> | null

The transaction URL if the activity is blockchain-related.

data.location

string | null

The physical or virtual location where the activity occurred.

data.owner_address

string | null

The blockchain address of the owner associated with this activity.

data.token_id

integer | null

The unique identifier of the product/token associated with this activity.

data.user_id

string<uuid> | null

The unique identifier of the user who performed or is associated with this activity.

data.image

object

The image media associated with the activity. Note that only the url field is populated in activity responses.

Show child attributes

data.image.alt

string | null

Alternative text for the media.

data.image.created_at

string<date-time>

The creation timestamp of the media.

data.image.description

string | null

Description of the media.

data.image.file_type

string | null

The file type of the media.

data.image.id

integer

The unique identifier for the media.

data.image.poster_url

string<uri> | null

URL to the poster of the media.

data.image.size

integer | null

The size of the media in bytes.

data.image.tags

string[] | null

Tags associated with the media.

data.image.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.image.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.image.url

string<uri>

URL to the media.

data.video

object

The video media associated with the activity. Note that only the url and poster_url fields are populated in activity responses.

Show child attributes

data.video.alt

string | null

Alternative text for the media.

data.video.created_at

string<date-time>

The creation timestamp of the media.

data.video.description

string | null

Description of the media.

data.video.file_type

string | null

The file type of the media.

data.video.id

integer

The unique identifier for the media.

data.video.poster_url

string<uri> | null

URL to the poster of the media.

data.video.size

integer | null

The size of the media in bytes.

data.video.tags

string[] | null

Tags associated with the media.

data.video.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.video.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.video.url

string<uri>

URL to the media.

data.gallery

object[] | null

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

Show child attributes

data.gallery.alt

string | null

Alternative text for the media.

data.gallery.created_at

string<date-time>

The creation timestamp of the media.

data.gallery.description

string | null

Description of the media.

data.gallery.file_type

string | null

The file type of the media.

data.gallery.id

integer

The unique identifier for the media.

data.gallery.poster_url

string<uri> | null

URL to the poster of the media.

data.gallery.size

integer | null

The size of the media in bytes.

data.gallery.tags

string[]

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

data.gallery.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

data.gallery.updated_at

string<date-time> | null

The last updated timestamp of the media.

data.gallery.url

string<uri>

URL to the media.

data.gallery.order

integer | null

Order of the gallery item.

data.gallery.variants

(string | null)[]

Variants of the gallery item.

data.gallery.type

string | null

Type of the gallery item.

data.gallery.caption

string | null

Caption of the gallery item.

data.created_at

string<date-time>

The timestamp when the activity was created.

data.updated_at

string<date-time> | null

The timestamp when the activity was last updated.

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

Create an activityCreates a new customer activity for a product, including an image upload.

⌘I

List activities

curl --request GET \
  --url https://api.oneofnone.io/v1/activities \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "type": "CREATOR",
      "title": "<string>",
      "content": "<string>",
      "json": {},
      "tx_url": "<string>",
      "location": "<string>",
      "owner_address": "<string>",
      "token_id": 123,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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"
    }
  ],
  "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

Query Parameters

Response