Skip to main content
GET
/
api
/
public
/
v1
/
surveys
/
nps
/
responses
List NPS responses
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/surveys/nps/responses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "surveyId": "<string>",
      "score": 5,
      "feedbackText": "<string>",
      "companyId": "<string>",
      "companyName": "<string>",
      "respondentName": "<string>",
      "respondentEmail": "<string>",
      "responseDate": "2023-11-07T05:31:56Z",
      "source": "<string>",
      "followUpRequired": true,
      "followUpCompleted": true,
      "tags": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

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
string

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