Skip to main content
GET
/
v1
/
avatars
{
  "data": [
    {
      "visibility": "public",
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "name": "John Doe",
      "status": "to-train"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your Beyond Presence API Key.

Query Parameters

​
limit
integer
default:10

Maximum number of objects to return.

Required range: 0 < x <= 50
​
cursor
string | null

Cursor for pagination.

Response

Paginated List of Avatars

  • HasMorePage[AvatarResponse]
  • NoMorePage[AvatarResponse]
​
data
AvatarResponse · object[]
required

List of objects.

​
next_cursor
string
required

The cursor for the next page of objects.

​
has_more
boolean
default:true

Whether there are more objects to fetch.