Skip to main content
GET
Get a CSAT 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 CSAT tool.

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

Response

CSAT tool definition

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

"507f1f77bcf86cd799439011"

name
string

Internal name of the CSAT tool.

Example:

"Post-purchase CSAT"

question
string

Survey question shown to the respondent.

Example:

"How satisfied are you with your purchase?"

subject
string | null

Optional subject or context for the survey.

Example:

"Order #1234"

availableLocales
string[]

Locales the survey is available in.

defaultLocale
string

Default locale for the survey.