Skip to main content
GET
/
api
/
v1
/
bots
/
{object_id}
/
participants
List Participants
curl --request GET \
  --url https://api.example.com/api/v1/bots/{object_id}/participants
{
  "next": {},
  "previous": {},
  "results": [
    {}
  ],
  "id": "<string>",
  "name": "<string>",
  "uuid": "<string>",
  "user_uuid": {},
  "is_host": true
}
Returns the list of participants for a bot. Results are paginated using cursor pagination.

​
Authentication

Requires API key authentication via the Authorization header.

​
Path Parameters

​
object_id
string
required
Bot ID (e.g., bot_xxxxxxxxxxx)

​
Query Parameters

​
cursor
string
Cursor for pagination. Use the next value from the previous response to get the next page.
​
id
string
Filter participants by participant ID (e.g., par_xxxxxxxxxxx)
​
is_host
boolean
Filter participants by whether they are the meeting host

​
Response

​
next
string | null
URL for the next page of results, or null if no more results
​
previous
string | null
URL for the previous page of results, or null if on first page
​
results
array
Array of participant objects

​
Participant Object

​
id
string
Unique identifier for the participant
​
name
string
Name of the participant
​
uuid
string
UUID of the participant
​
user_uuid
string | null
User UUID (platform-specific persistent identifier for the participant)
​
is_host
boolean
Whether the participant is the meeting host

​
Example Request

curl https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participants \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​
Example with Host Filter

curl "https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participants?is_host=true" \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​
Example with Participant ID Filter

curl "https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participants?id=par_abc123xyz" \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

​
Example with Pagination

curl "https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participants?cursor=cD00ODY%3D" \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Build docs developers (and LLMs) love

Get started for freeTalk to us