List Jobs

get

https://{subdomain}.pinpointhq.com/api/v1/jobs

Query Params

extra_fields[jobs]

array of objects

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

include

array of strings

Include related resources

fields[jobs]

array of objects

Include only specified fields of Job in response

fields[departments]

array of objects

Include only specified fields of Department in response

fields[divisions]

array of objects

Include only specified fields of Division in response

fields[locations]

array of objects

Include only specified fields of Location in response

fields[structure_custom_group_ones]

array of objects

Include only specified fields of Structure Custom Group One in response

fields[companies]

array of objects

Include only specified fields of Company in response

fields[structure_links]

array of objects

Include only specified fields of Structure Link in response

fields[users]

array of objects

Include only specified fields of User in response

fields[applications]

array of objects

Include only specified fields of Application in response

fields[job_postings]

array of objects

Include only specified fields of Job Posting in response

fields[questions]

array of objects

Include only specified fields of Question in response

fields[custom_attributes]

array of objects

Include only specified fields of Custom Attribute in response

fields[stages]

array of objects

Include only specified fields of Stage in response

filter[created_at][gt]

date-time

Filter records with created_at greater than this value

filter[created_at][lt]

date-time

Filter records with created_at less than this value

filter[updated_at][gt]

date-time

Filter records with updated_at greater than this value

filter[updated_at][lt]

date-time

Filter records with updated_at less than this value

filter[employment_type]

array of strings

Filter records with employment_type equal to this value

filter[workplace_type]

array of strings

Filter records with workplace_type equal to this value

filter[visibility]

array of strings

Filter records with visibility equal to this value

filter[status]

array of strings

Filter records with status equal to this value

filter[remote]

boolean

Filter records based on whether they're marked as remote

filter[department_id]

array of strings

Filter records by Department id

filter[department_id]

filter[department_name]

array of strings

Filter records by Department name

filter[department_name]

filter[division_id]

array of strings

Filter records by Division id

filter[division_id]

filter[division_name]

array of strings

Filter records by Division name

filter[division_name]

filter[location_id]

array of strings

Filter records by Location id

filter[location_id]

filter[location_name]

array of strings

Filter records by Location name

filter[location_name]

filter[structure_custom_group_one_id]

array of strings

Filter records by Structure custom group one id

filter[structure_custom_group_one_id]

filter[structure_custom_group_one_name]

array of strings

Filter records by Structure custom group one name

filter[structure_custom_group_one_name]

filter[search]

array of strings

Filter records by Search

filter[search]

filter[non_rejected_applications]

integer

Filter records by Non rejected applications

filter[hiring_manager_user_id]

string

Filter records by Hiring manager user id

filter[recruitment_manager_user_id]

string

Filter records by Recruitment manager user id

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

page[number]

integer

Defaults to 1

The page number of records to return

page[size]

integer

0 to 1000

Defaults to 100

The number of records to return

stats[total]

string

enum

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

Allowed:

Responses

200OK: Jobs collection

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error