API Reference

surveyRequest.list

post
https://api.ashbyhq.com/surveyRequest.list

Lists all survey requests.

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

Requires the candidatesRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

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

Allowed:

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

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

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

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

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

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

Response

Updated about 1 month ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago