Skip to main content
GET
List messages
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Path Parameters

conversation_id
string<uuid>
required

Id of the conversation. You can get conversation_id by listing conversations using our List conversations API.

Example:

"de414e85-a1b5-4240-a465-7b32606980ce"

Query Parameters

page
integer

Page number to retrieve, starting from 1. Defaults to 1 when omitted.

Example:

1

per_page
integer

Number of records per page. Defaults to 15 when omitted, and values above 100 are capped at 100. page_size is accepted as an alias.

Example:

15

Response

OK - Request succeeded

messages
object[]
pagination
object