Skip to main content
GET
/
api
/
v1
/
bots
/
{object_id}
/
participant_events
Get Participant Events
curl --request GET \
  --url https://api.example.com/api/v1/bots/{object_id}/participant_events
{
  "next": {},
  "previous": {},
  "results": [
    {}
  ],
  "id": "<string>",
  "participant_name": "<string>",
  "participant_uuid": "<string>",
  "participant_user_uuid": {},
  "participant_is_host": true,
  "event_type": "<string>",
  "event_data": {},
  "timestamp_ms": 123
}
Returns participant events (join/leave) 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.
after
string
Only return participant events created after this time. Useful when polling for updates. Format: ISO 8601 datetime (e.g., 2024-01-18T12:34:56Z)
before
string
Only return participant events created before this time. Format: ISO 8601 datetime (e.g., 2024-01-18T13:34:56Z)

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 event objects

Participant Event Object

id
string
Unique identifier for the event
participant_name
string
Name of the participant
participant_uuid
string
UUID of the participant
participant_user_uuid
string | null
User UUID (platform-specific persistent identifier)
participant_is_host
boolean
Whether the participant is the meeting host
event_type
string
Type of event (e.g., ‘join’, ‘leave’)
event_data
object
Additional data about the event
timestamp_ms
integer
Timestamp of the event in milliseconds

Example Request

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

Example with Time Range

curl "https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participant_events?after=2024-01-18T12:34:56Z&before=2024-01-18T13:34:56Z" \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Example with Polling

curl "https://app.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ/participant_events?after=2024-01-18T12:34:56Z" \
  -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/participant_events?cursor=cD00ODY%3D" \
  -H "Authorization: Token YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"
Use the after parameter to poll for new participant events. This is useful for tracking when participants join or leave during an ongoing meeting.

Build docs developers (and LLMs) love