API Reference

List Candidate Surveys

get
https://{subdomain}.pinpointhq.com/api/v1/candidate_surveys
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
include
array of strings

Include related resources

fields[candidate_surveys]
array of objects

Include only specified fields of Candidate Survey in response

fields[applications]
array of objects

Include only specified fields of Application in response

date-time

Filter records with responded_at greater than this value

date-time

Filter records with responded_at less than this value

date-time

Filter records with created_at greater than this value

date-time

Filter records with created_at less than this value

date-time

Filter records with updated_at greater than this value

date-time

Filter records with updated_at less than this value

string

Filter records by Job id

string

Filter records by Application id

boolean

Filter records based on whether they're marked as responded

sort
array of strings

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 11 months ago