Skip to main content
GET
/
questionnaires
/
{id}
Retrieves detailed information about a specific questionnaire including its questions, answers, and associated clients.
curl --request GET \
  --url https://api.example.com/questionnaires/{id}
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "firstMessage": "<string>",
  "retryIntervalDays": 123,
  "maxTries": 123,
  "intervalBackOffMultiplier": 123,
  "repeatIntervalDays": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "questions": [
    {
      "id": 123,
      "questionnaireId": 123,
      "position": 123,
      "type": "<string>",
      "prompt": "<string>",
      "metadata": "<string>"
    }
  ],
  "answers": [
    {
      "questionId": 123,
      "questionnaireCallId": 123,
      "prompt": "<string>",
      "type": "<string>",
      "metadata": "<string>",
      "answerText": "<string>",
      "answeredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "clients": [
    {
      "id": 123,
      "clientId": 123,
      "questionnaireId": 123,
      "phoneCallId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "nextTryAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

id
integer<int32>
required

The unique identifier of the questionnaire.

Response

Successfully retrieved the questionnaire details.

id
integer<int32>
name
string | null
description
string | null
firstMessage
string | null
retryIntervalDays
integer<int32>
maxTries
integer<int32>
intervalBackOffMultiplier
integer<int32>
repeatIntervalDays
integer<int32>
createdAt
string<date-time>
questions
object[] | null
answers
object[] | null
clients
object[] | null