Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Survey Submission

surveySubmission.list

Lists all survey submissions of a given surveyType.

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

Requires the candidatesRead permission.

post/surveySubmission.list

Request body

surveyType'CandidateExperience' | 'Questionnaire' | 'HiringManagerExperience' required

The survey types supported by surveySubmission.list. Supported values: CandidateExperience, Questionnaire, HiringManagerExperience.

cursorstring nullable

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

limitinteger nullable

The maximum number of survey submissions to return per page.

syncTokenstring nullable

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

createdAfterinteger nullable

Return survey submissions created at or after this date. Unix timestamp in milliseconds.

Example request

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

Response

Responses from the surveySubmission.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "surveyFormDefinitionId": "49e621fa-b342-413a-b876-5d924689c23b",
      "submittedAt": "2026-05-21T02:02:17.342Z",
      "candidateId": "d13f3430-d0de-4305-b41c-444d02f19954",
      "applicationId": "38fdb18a-5753-48e0-8a55-d8a124c346b2",
      "surveyType": "CandidateExperience",
      "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
                }
              }
            ]
          }
        ]
      },
      "submittedValues": {
        "_systemfield_overall_candexp_rating": "5"
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}