Skip to main content
GET
/
api
/
public
/
v1
/
surveys
/
{id}
Get general survey
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/surveys/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "isActive": true,
    "publishedAt": "2023-11-07T05:31:56Z",
    "version": 123,
    "questionCount": 123,
    "responseCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "questions": [
      {
        "id": "<string>",
        "questionText": "<string>",
        "answerType": "short_text",
        "displayOrder": 123,
        "isRequired": true,
        "isActive": true,
        "options": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayOrder": 123
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

Response

Survey details with questions

​
data
object
required