Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Survey Request

surveyRequest.list

Lists all survey requests.

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

Requires the candidatesRead permission.

post/surveyRequest.list

Request body

surveyType'CandidateExperience' required

Returns only the survey requests of the given type. Currently, only CandidateExperience is supported.

applicationIdstring uuid nullable

If provided, only returns the survey requests for the application with the supplied id.

candidateIdstring uuid nullable

If provided, only returns the survey requests for the candidate with the supplied id.

cursorstring nullable

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

limitnumber nullable

The maximum number of items to return. The maximum and default value is 100.

syncTokenstring nullable

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

createdAfternumber nullable

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

Example request

{
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "candidateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the surveyRequest.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "surveyUrl": "https://example.ashbyhq.com/acme/survey/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "surveyFormDefinitionId": "49e621fa-b342-413a-b876-5d924689c23b",
      "applicationId": "38fdb18a-5753-48e0-8a55-d8a124c346b2",
      "candidateId": "d13f3430-d0de-4305-b41c-444d02f19954"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}