Skip to main content
GET
/
v1
/
csat
/
{id}
Get a single CSAT response
curl --request GET \
  --url https://clientapi.woku.app/v1/csat/{id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "score": 3,
  "anonymous": true,
  "csatToolId": "<string>",
  "clientId": "<string>",
  "responseChannel": "<string>",
  "description": "<string>",
  "transcription": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Path Parameters

id
string
required

CSAT response id

Response

CSAT response

A CSAT response. Client contact data is never included; clientId is a reference only. The optional comment (text or voice) is inlined on the response. CSAT has no promoter/passive/detractor category.

_id
string
score
integer
Required range: 1 <= x <= 5
anonymous
boolean
csatToolId
string | null
clientId
string | null
responseChannel
string | null

Inbound response channel (whatsapp | email | review-app | widget-web | mobile-sdk | api, or a user-defined string). Null on historical responses.

commentType
enum<string> | null

Which kind of comment is attached, if any.

Available options:
textnote,
voicemail,
null
description
string | null

Text comment content (present when commentType is 'textnote').

transcription
string | null

Voice comment transcription (present when commentType is 'voicemail').

feedbackType
enum<string> | null

AI classification of the comment. Null until classified or when there is no comment.

Available options:
recognition,
improvement,
null
createdAt
string<date-time>