REST API v1

Surveys

Base URL https://your-site.com/wp-json/cliedesk-api/v1. See the overview for keys, scopes and errors.

List survey responses

GET /survey-responses

Scope surveys:read · Cost 1

Parameters

Name	Type	Description
`kind`	query · string	One of: csat, nps, ces, custom
`survey_id`	query · integer
`contact_id`	query · string
`product_id`	query · string
`after`	query · integer
`limit`	query · integer
`answered`	query · boolean

Write a survey response from another tool

POST /survey-responses

Scope surveys:write · Cost 2

Parameters

Name	Type	Description
`Idempotency-Key`	header · string

Request body (JSON)

Name	Type	Description
`kind` required	string	One of: csat, nps, ces
`score` required	integer
`contact_id`	string
`email`	string
`conversation_id`	string
`product_id`	string
`comment`	string
`responded_at`	string
`source`	string

Read a survey response

GET /survey-responses/{id}

Scope surveys:read · Cost 1

Parameters

Name	Type	Description
`id` required	path · integer

List surveys

GET /surveys

Scope surveys:read · Cost 1

Create a survey

POST /surveys

Scope surveys:write · Cost 2

Parameters

Name	Type	Description
`Idempotency-Key`	header · string

Request body (JSON)

Name	Type	Description
`name` required	string
`kind` required	string	One of: nps, ces, custom
`status`	string	One of: draft, active, paused
`product_id`	string
`questions`	string
`delivery`	string
`schedule`	string