List submissions
List NPS submissions for a project, newest first, with paging and filters.
GET /nps/submissionsAuthentication
Send your API key as a bearer token. See Authentication .
Query parameters
| Parameter | Type | Default | Notes |
projectId | UUID | required | The project to read. |
page | integer | 1 | The page number, starting at 1. |
pageSize | integer | 25 | Rows per page. The maximum is 100. |
search | string | none | Free text search across comments. |
status | string | none | active or flagged. |
category | string | none | detractor, passive, or promoter. |
formBuilderId | UUID | none | Only rows from this form. |
customerId | UUID | none | Only 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
| Field | Type | Notes |
npsSubmissionId | string | The ID of the submission. |
projectId | string | The project the submission belongs to. |
formBuilderId | string | The form the submission came from. |
customerId | string or null | The linked customer, if any. |
score | number | 0 to 10. |
comment | string or null | The free text comment. |
category | string | detractor, passive, or promoter. |
status | string | active or flagged. |
source | string | Always form. |
createdAt | string | When the response arrived, as an ISO date. |
updatedAt | string | When the response was last changed, as an ISO date. |
formName | string or null | The name of the form. |
customerName | string or null | The linked customer name. |
customerEmail | string or null | The linked customer email. |
customerAvatarUrl | string or null | The 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?