latestOpenAPI 3.0.2MIT2026-08-1745267541.8 KB

bdb3e0c48bf7

Events

List events

List all events in a project

get/v1/projects/{project_id}/events

Query parameters

conversation_idstring

Resource name (id) of the conversation. One of conversation_id or contact_id needs to be present.

contact_idstring

Resource name (id) of the contact. One of conversation_id or contact_id needs to be present.

page_sizeinteger

Maximum number of events to fetch. Defaults to 10 and the maximum is 20.

page_tokenstring

Next page token previously returned if any. When specifying this token, make sure to use the same values for the other parameters from the request that originated the token, otherwise the paged results may be inconsistent.

Response

A successful response.

next_page_tokenstring

Token that should be included in the next request to fetch the next page.

Example response

{
  "events": [
    {
      "channel_identity": {
        "channel": "WHATSAPP"
      }
    }
  ]
}