Skip to main content
GET
List NPS responses

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
sortColumn
enum<string>
default:response_date

Field to sort by

Available options:
response_date,
score,
respondent_name,
created_at
sortDesc
boolean | null
default:true

Sort descending

surveyId
string<uuid>

Filter by survey ID

companyId
string<uuid>

Filter by company ID

category
enum<string>

Filter by NPS category

Available options:
promoter,
passive,
detractor
followUpRequired
boolean | null

Filter by follow-up required status

Search by respondent name, email, or feedback

Maximum string length: 255
dateFrom
string<date-time>

Filter by response date (from)

dateTo
string<date-time>

Filter by response date (to)

Response

List of NPS responses

data
object[]
required
pagination
object
required