List conversations

GEThttps://server.heyrik.com/api/v1/chat/sessions

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Fields documented for this operation. See the request example for placement and structure.

agent_idstring

Only this agent's chats. `agency_id` also accepted.

limit / offsetnumber

Pagination — walk with has_more.

Explore the example values. This is not a complete response schema.

dataobject

Explore 3 properties

itemsarray

Explore 1 example item

[0]object

Explore 3 properties

idstring

Example "cht_c09b79cc"

titlestring

Example "Support chat"

message_countnumber

Example 4

totalnumber

Example 1

has_moreboolean

Example false

GET/chat/sessions

cURL

curl "https://server.heyrik.com/api/v1/chat/sessions?agent_id=agc_9f2a1c30&limit=20" \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{ "data": { "items": [ { "id": "cht_c09b79cc", "title": "Support chat", "message_count": 4 } ], "total": 1, "has_more": false } }

Illustrative examples · No live request is sent