Skip to main content
GET
/
v1
/
nps
/
{id}
Get a single NPS response
curl --request GET \
  --url https://clientapi.woku.app/v1/nps/{id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "score": 5,
  "anonymous": true,
  "npsToolId": "<string>",
  "clientId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "textnote": {
    "description": "<string>",
    "anonymous": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "voicemail": {
    "transcription": "<string>",
    "anonymous": true,
    "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

NPS response id

Response

NPS response

An NPS response. Client contact data is never included; clientId is a reference only.

_id
string
score
integer
Required range: 0 <= x <= 10
category
enum<string>
Available options:
promoter,
passive,
detractor
anonymous
boolean
npsToolId
string | null
clientId
string | null
createdAt
string<date-time>
textnote
object
voicemail
object