Skip to main content
GET
/
api
/
public
/
v1
/
surveys
/
{id}
/
responses
List survey responses
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/surveys/{id}/responses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "inviteId": "<string>",
      "surveyId": "<string>",
      "companyId": "<string>",
      "companyName": "<string>",
      "respondentName": "<string>",
      "respondentEmail": "<string>",
      "completedAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "answers": [
        {
          "questionId": "<string>",
          "questionText": "<string>",
          "answerText": "<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.

Path Parameters

​
id
string<uuid>
required

Survey ID

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:completed_at

Field to sort by

Available options:
completed_at,
sent_at,
recipient_name,
recipient_email
​
sortDesc
boolean | null
default:true

Sort descending

​
search
string

Search by respondent name or email

Maximum string length: 255
​
companyId
string<uuid>

Filter by company ID

Response

List of survey responses

​
data
object[]
required
​
pagination
object
required