List Avatars

curl --request GET \
  --url https://api.example.com/v1/avatars \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

GET

avatars

List Avatars

curl --request GET \
  --url https://api.example.com/v1/avatars \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

x-api-key

string

header

required

Your Beyond Presence API Key.

limit

integer

default:10

Maximum number of objects to return.

Required range: x <= 50

cursor

string | null

Cursor for pagination.

Paginated List of Avatars

data

AvatarResponse · object[]

required

List of objects.

Show child attributes

next_cursor

string

required

The cursor for the next page of objects.

has_more

boolean

default:true

Whether there are more objects to fetch.

Documentation Index