API Reference

List Candidates

get
https://{subdomain}.pinpointhq.com/api/v1/candidates
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Phone filter

Use filter[phone] to filter candidates by phone number.

Phone numbers should be provided in E.164 format. When passing the value in a query string, URL-encode a leading + as %2B.

Example: filter[phone]=%2B44000000000

Query Params
extra_fields[candidates]
array of objects

Include fields that are not always needed, or perhaps computationally expensive

include
array of strings

Include related resources

fields[candidates]
array of objects

Include only specified fields of Candidate in response

fields[applications]
array of objects

Include only specified fields of Application in response

fields[hris_exports]
array of objects

Include only specified fields of Hris Export in response

fields[job_seekers]
array of objects

Include only specified fields of Job Seeker in response

fields[skills]
array of objects

Include only specified fields of Skill in response

fields[custom_attributes]
array of objects

Include only specified fields of Custom Attribute in response

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

filter[external_system_reference]
array of strings

Filter records by External system reference

filter[external_system_reference]
boolean

Filter records based on whether they're marked as blocked

filter[phone]
array of strings

Filter records by Phone

filter[phone]
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 about 1 month 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 about 1 month ago