Contendar Help

List submissions

List NPS submissions for a project, newest first, with paging and filters.

GET /nps/submissions

Authentication

Send your API key as a bearer token. See Authentication .

Query parameters

ParameterTypeDefaultNotes
projectIdUUIDrequiredThe project to read.
pageinteger1The page number, starting at 1.
pageSizeinteger25Rows per page. The maximum is 100.
searchstringnoneFree text search across comments.
statusstringnoneactive or flagged.
categorystringnonedetractor, passive, or promoter.
formBuilderIdUUIDnoneOnly rows from this form.
customerIdUUIDnoneOnly rows from this customer.

The category is set from the score. 0 to 6 is a detractor. 7 to 8 is passive. 9 to 10 is a promoter.

Response

{
  "data": [
    {
      "npsSubmissionId": "d3f2e5c4-8b6a-4d0c-9e3f-4a5b6c7d8e9f",
      "projectId": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
      "formBuilderId": "1f2e3d4c-5b6a-7980-1234-56789abcdef0",
      "customerId": null,
      "score": 9,
      "comment": "Would recommend to any marketing team.",
      "category": "promoter",
      "status": "active",
      "source": "form",
      "createdAt": "2026-08-25T08:30:00.000Z",
      "updatedAt": "2026-08-25T08:30:00.000Z",
      "formName": "Quarterly NPS survey",
      "customerName": null,
      "customerEmail": null,
      "customerAvatarUrl": null
    }
  ],
  "pagination": { "page": 1, "pageSize": 25, "total": 1, "totalPages": 1 }
}

Response fields

FieldTypeNotes
npsSubmissionIdstringThe ID of the submission.
projectIdstringThe project the submission belongs to.
formBuilderIdstringThe form the submission came from.
customerIdstring or nullThe linked customer, if any.
scorenumber0 to 10.
commentstring or nullThe free text comment.
categorystringdetractor, passive, or promoter.
statusstringactive or flagged.
sourcestringAlways form.
createdAtstringWhen the response arrived, as an ISO date.
updatedAtstringWhen the response was last changed, as an ISO date.
formNamestring or nullThe name of the form.
customerNamestring or nullThe linked customer name.
customerEmailstring or nullThe linked customer email.
customerAvatarUrlstring or nullThe linked customer avatar.

Example

curl "https://app.contendar.com/api/v1/nps/submissions?projectId=YOUR_PROJECT_ID&category=detractor&page=1&pageSize=25" \
  -H "Authorization: Bearer ck_your_key_here"

Related pages

Was this helpful?