Skip to main content
GET
Get an NPS tool definition

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 NPS tool.

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

Response

NPS tool definition

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

"507f1f77bcf86cd799439011"

name
string

Internal name of the NPS tool.

Example:

"Post-checkout NPS"

npsMessage
string

Company or product referenced in the survey question.

Example:

"Acme Store"

audienceType
string

Audience referenced in the survey question.

Example:

"shoppers"