Skip to main content
GET
/
v1
/
ces
/
{id}
Get a single CES response
curl --request GET \
  --url https://clientapi.woku.app/v1/ces/{id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "score": 3,
  "anonymous": true,
  "cesToolId": "<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

MongoDB ObjectId of the CES response.

Pattern: ^[0-9a-fA-F]{24}$

Response

CES response

A CES response. Client contact data is never included; clientId is a reference only.

​
_id
string
​
score
integer

CES effort score on a 1-5 scale.

Required range: 1 <= x <= 5
​
anonymous
boolean
​
cesToolId
string | null
​
clientId
string | null

Reference to the respondent. Always null for anonymous responses.

​
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

Kind of the attached optional comment, if any.

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

Text feedback content (present only when commentType is textnote).

​
transcription
string | null

Audio transcription (present only when commentType is voicemail).

​
feedbackType
enum<string> | null

AI-classified category of the comment; filled asynchronously.

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