Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Survey Form Definition

surveyFormDefinition.info

Returns details about a single survey form definition by id.

Requires the hiringProcessMetadataRead permission.

post/surveyFormDefinition.info

Request body

surveyFormDefinitionIdstring uuid required

The unique identifier of the survey form definition to fetch

Example request

{
  "surveyFormDefinitionId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the surveyFormDefinition.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "49e621fa-b342-413a-b876-5d924689c23b",
    "title": "Example Candidate Experience Survey",
    "isArchived": false,
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": false,
              "field": {
                "id": "cb539763-33a2-4172-a915-dc14d9120671",
                "type": "NPSRating",
                "path": "_systemfield_overall_candexp_rating",
                "humanReadablePath": "",
                "title": "How likely are you to recommend us to others?",
                "isNullable": false
              }
            }
          ]
        }
      ]
    },
    "surveyType": "CandidateExperience"
  }
}