Skip to main content
GET
List CSAT responses

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

since
string

Start of the period, as Unix epoch seconds.

until
string

End of the period, as Unix epoch seconds.

user_ids
string

Restrict to responses on conversations assigned to these agents.

inbox_id
integer

Restrict to one inbox.

team_id
integer

Restrict to one team.

rating
integer

Restrict to one score, 1 to 5.

page
integer
default:1

The page parameter

Response

Success

id
integer

The numeric ID of the response.

rating
integer

The score the contact gave, 1 to 5.

feedback_message
string | null

The free-text comment. Null when the contact rated without commenting.

account_id
integer

The account the response belongs to.

message_id
integer

The survey message this response answers. One response per message.

conversation_id
integer

The conversation the survey was sent in.

contact
object
created_at
integer

When the rating was recorded, as a Unix epoch in seconds.