Skip to main content
GET
List CSAT answers

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

Query Parameters

conversation_id
integer

Return every answer of this conversation, by its display_id — the number in the dashboard URL. With it, the window becomes optional. A conversation from another account, or with no answer, returns an empty page.

created_after
string<date-time>

Start of the window, inclusive. ISO 8601. Required with created_before unless conversation_id is sent; the window spans at most 31 days.

created_before
string<date-time>

End of the window, exclusive. Half-open windows never double-count when you walk a period window by window.

rating
integer

Keep only answers with this score, from 1 to 5.

Required range: 1 <= x <= 5
assignee_id
integer

Keep only answers credited to this agent — the one assigned when the survey went out.

inbox_id
integer

Keep only answers from conversations of this inbox.

team_id
integer

Keep only answers from conversations currently assigned to this team.

after_id
integer

Cursor: omit it on the first call, then send the meta.next_after_id of the previous page with the same other parameters. An id that is not an answer of this account returns 400.

per_page
integer
default:25

Page size. Default 25, capped at 100.

Required range: x <= 100

Response

A page of CSAT answers, oldest first. data is empty when nothing matches.

data
object[]
required
meta
object
required