Get participant events for a bot

​

Returns the participant events (join/leave) for a bot. Results are paginated using cursor pagination.

Path Parameters
  • object_id
    Type: string
    required

    Bot ID

Query Parameters
  • after
    Type: stringFormat: ISO 8601 datetime

    Only return participant events created after this time. Useful when polling for updates.

  • before
    Type: stringFormat: ISO 8601 datetime

    Only return participant events created before this time.

  • cursor
    Type: string

    Cursor for pagination

Headers
  • Authorization
    Type: string
    required

    API key for authentication

  • Content-Type
    Type: string
    required

    Should always be application/json

Responses
  • application/json
  • 404

    Bot not found

Request Example for get/api/v1/bots/{object_id}/participant_events
curl 'https://app.attendee.dev/api/v1/bots/bot_xxxxxxxxxxx/participant_events?after=2024-01-18T12%3A34%3A56Z&before=2024-01-18T13%3A34%3A56Z&cursor=' \
  --header 'Authorization: Token YOUR_API_KEY_HERE' \
  --header 'Content-Type: application/json'

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "string",
      "participant_name": "string",
      "participant_uuid": "string",
      "participant_user_uuid": null,
      "participant_is_host": true,
      "event_type": "string",
      "event_data": null,
      "timestamp_ms": 1
    }
  ]
}

List of participant events