Get conversations

GET

/api/v1/visitors/conversations

List the workspace’s conversations, or fetch one conversation’s transcript.

Notes

• Pass conversationId or conversationUrl to get a single transcript instead of a page of the list. The response shape differs between the two modes
• Without either, the result is a page of the list, sorted by createdAt descending unless you say otherwise
• Use GET /api/v1/ai/conversations/details instead when you want the analysis of a conversation rather than its messages

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

conversationId

string

Fetch this conversation’s transcript instead of the list.

conversationUrl

string

Fetch a transcript by its storage key. Takes precedence over conversationId.

page

integer

rowsPerPage

integer

sortField

string

Field to sort on. Defaults to createdAt.

sortDirection

string

default: desc

Allowed values: asc desc

filterField

string

filterValue

string

filterOperator

string

Allowed values: contains is

Responses

200

A page of conversations, or one conversation’s transcript.

400

Bad request - missing websiteId.

401

Unauthorized - invalid API key.

500

The conversationId or conversationUrl did not resolve to a conversation.