Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Survey Form Definition

surveyFormDefinition.list

Lists all survey form definitions.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the hiringProcessMetadataRead permission.

post/surveyFormDefinition.list

Request body

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

syncTokenstring nullable

A sync token to retrieve only survey form definitions updated since the last sync. Obtained from a previous list response.

limitinteger nullable

The maximum number of survey form definitions to return per page.

Example request

{
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the surveyFormDefinition.list 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"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}