---
title: "List events"
method: GET
path: "/v1/projects/{project_id}/events"
tags: ["Events"]
---

# List events

`GET /v1/projects/{project_id}/events`

List all events in a project

## Query parameters

- `conversation_id` string
- `contact_id` string
- `page_size` integer
- `page_token` string

## Response `200`

A successful response.

- ListEventsResponse
  - `events` ConversationEvent[] — List of ConversationsEvents.
    - `app_event` union — Event originating from an app
      - object
        - `composing_event` object — Represents a typing indicator shown to the contact.
      - object
        - `composing_end_event` object — Represents a typing-end indicator. Stops a typing indicator previously shown to the contact.
      - object
        - `read_message_event` object — Marks an inbound (contact) message as read on the channel, producing a read receipt for the contact. Supported on the WhatsApp channel.
      - object
        - `comment_reply_event` object — Represents a response to a comment event.
          - `text` string, required — The text of the comment reply.
      - object
        - `agent_joined_event` object
          - `agent` Agent, required — Represents an agent that is involved in a conversation.
            - `display_name` string — Agent's display name
            - `type` 'UNKNOWN_AGENT_TYPE' | 'HUMAN' | 'BOT' — Agent's classification. It can be UNKNOWN_AGENT_TYPE, HUMAN or BOT.
            - `picture_url` string — The Agent's picture url.
      - object
        - `agent_left_event` object
          - `agent` Agent, required — Represents an agent that is involved in a conversation.
            - `display_name` string — Agent's display name
            - `type` 'UNKNOWN_AGENT_TYPE' | 'HUMAN' | 'BOT' — Agent's classification. It can be UNKNOWN_AGENT_TYPE, HUMAN or BOT.
            - `picture_url` string — The Agent's picture url.
      - object
        - `generic_event` object — Event that contains only a flexible payload field.
          - `payload` object, required — Arbitrary data set to the event. A valid JSON object.
    - `conversation_id` string — Optional. The ID of the event's conversation. Will not be present for apps in Dispatch Mode.
    - `contact_id` string — Optional. The ID of the contact. Will not be present for apps in Dispatch Mode.
    - `channel_identity` ChannelIdentity, required — A unique identity of message recipient on a particular channel. For example, the channel identity on SMS, WHATSAPP or VIBERBM is a MSISDN phone number.
      - `app_id` string — Required if using a channel that uses app-scoped channel identities. Currently, FB Messenger, Instagram, LINE, and WeChat use app-scoped channel identities, which means contacts will have different channel identities on different Conversation API apps. These can be thought of as virtual identities that are app-specific and, therefore, the app_id must be included in the API call.
      - `channel` 'SMS' | 'RCS' | 'WHATSAPP' | 'MMS' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'VIBERBM' | 'LINE' | 'INSTAGRAM' | 'MESSENGER' | 'WECHAT' | 'TELEGRAM' | 'APPLEBC', required — The identifier of the channel you want to include. Must be one of the enum values.
      - `identity` string, required — The channel identity. This will differ from channel to channel. For example, a phone number for SMS, WhatsApp, and Viber Business.
    - `accept_time` string, date-time — The processed time of the message in UTC timezone. Must be less than current_time and greater than (current_time - 30 days).
    - `processing_mode` 'CONVERSATION' | 'DISPATCH', required — Whether or not Conversation API should store contacts and conversations for the app. For more information, see [Processing Modes](https://developers.sinch.com/docs/conversation/processing-modes/).
    - `direction` 'TO_APP' | 'TO_CONTACT' — The direction of the message flow, indicating whether the message was sent to or from the Conversation API app.
    - `id` string, required — The ID of the event.
  - `next_page_token` string — Token that should be included in the next request to fetch the next page.

## Other responses

- `400` — Malformed request. See [common error responses](https://developers.sinch.com/docs/conversation/api-reference/#common-error-responses) for more information.
- `401` — Incorrect credentials. See [common error responses](https://developers.sinch.com/docs/conversation/api-reference/#common-error-responses) for more information.
- `403` — Correct credentials but you don't have access to the requested resource. See [common error responses](https://developers.sinch.com/docs/conversation/api-reference/#common-error-responses) for more information.
- `500` — Correct credentials but you don't have access to the requested resource. See [common error responses](https://developers.sinch.com/docs/conversation/api-reference/#common-error-responses) for more information.
- `501` — Something went wrong on our end, try again with exponential back-off. See [common error responses](https://developers.sinch.com/docs/conversation/api-reference/#common-error-responses) for more information.

---

[API](https://skmtc.net/sinch/apis/conversation-api-sinch.md) · [All operations](https://skmtc.net/sinch/apis/conversation-api-sinch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/conversation-api-sinch/revisions/bdb3e0c48bf7/schema)