Skip to main content
GET
/
api
/
public
/
v1
/
surveys
/
nps
List NPS surveys
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/surveys/nps \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "questionText": "<string>",
      "frequencyInterval": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "isActive": true,
      "reminderEnabled": true,
      "reminderDaysAfter": 123,
      "followUpEnabled": true,
      "thankYouMessage": "<string>",
      "responseCount": 123,
      "inviteCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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:created_at

Field to sort by

Available options:
created_at,
updated_at,
title,
start_date
​
sortDesc
boolean | null
default:true

Sort descending

​
search
string

Search in survey title

Maximum string length: 255
​
isActive
boolean | null

Filter by active status

​
surveyType
enum<string>

Filter by survey type

Available options:
one_time,
recurring

Response

List of NPS surveys

​
data
object[]
required
​
pagination
object
required