| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint allows for listing Candidate Surveys.
By default, it will return all the surveys that were sent to the candidates (whether the candidate responded or not).
Including relationships
Application (candidate)
If you would like to include application data you have to request application inclusion. You can do it by adding include=application query param. Then the application data will be available in the included key of the response. See the example response in the right panel.
Job
If you need any job-related data you need to request application.jobinclusion. You can do it by adding include=application.job query param. Then the job (and application) data will be available in the included key of the response.
Stage
If you need the stage of the application that the survey belongs to you need to request application.stageinclusion. You can do it by adding include=application.stage query param. Then the stage (and application) data will be available in the included key of the response.
Answers to additional questions
If your candidate survey has additional questions, you can retrieve the answers byanswers relationship inclusion. You can do it by adding include=answers query param. Then the answers data will be available in the included key of the response. To get a question for each answer, you can do include=answers.question.
Filtering and sorting
Filter responded surveys
You can get only surveys with responses by using responded filter (filter[responded]=true query param).
The survey is considered responded to when responded_at isn't empty.
Filter by application or job
You can filter surveys by specific application_id or job_id. Examples:
filter[application_id]=1filter[job_id]=1
Other filters
Please find the documentation of all available sorting and filters in the table below.