API Reference

surveySubmission.list

post
https://api.ashbyhq.com/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.

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

The type of survey submissions to fetch. Supported values: CandidateExperience, Questionnaire, HiringManagerExperience.

Allowed:

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

≤ 9007199254740991

The maximum number of survey submissions to return per page.

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

-9007199254740991 to 9007199254740991

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

This feature is in beta and may not be available for all organizations. When true, each form field's visibilityCondition tree is included. Defaults to false on this endpoint to keep responses small.

Response

Updated 5 months 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 5 months ago