Docs
Conversations

List conversations

Returns a paginated list of chat conversations for the workspace, newest first.

GET/api/v1/conversations

Filter by chatbot, lead status, resolved state, lifecycle status, language, or start date. Messages are not included — fetch a single conversation to read its transcript.

Query parameters

Prop

Type

Response 200

Returns a data array with a pagination object. Each item:

Prop

Type

Errors

  • 401 — Missing or invalid API key
  • 429 — Rate limit exceeded

Every error shares one envelope.

Example

curl https://www.hey.support/api/v1/conversations \
  -H 'Authorization: Bearer hs_live_…'

List chatbots

Returns the workspace’s chatbots, newest first, with their sqid-encoded ids.

Get a conversation with its messages

Returns one conversation and its full message transcript, including visitor messages, AI replies, human agent replies, and internal notes.

On this page

Query parameters
Response 200
Errors
Example