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.

Body Params
int64

The API will return data after this date, which is the time since the unix epoch in milliseconds

string

Opaque cursor indicating which page of results to fetch

string

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

number

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

string
enum
required

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

Allowed:
uuid

If provided, only returns the offers for the application with the supplied id

uuid

If provided, only returns the offers for the candidate with the supplied id

Response

Updated 3 months ago

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