v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB

Job Seekers

List Job Seekers

get/api/v1/job_seekers

Query parameters

extra_fields[job_seekers]JobSeekersExtraFields[]

Job Seeker extra fields list

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

includestring[]

Job Seeker relationships available for inclusion

Include related resources

fields[job_seekers]JobSeekersReadableAttribute[]

Job Seeker readable attributes list

Include only specified fields of Job Seeker in response

fields[answers]AnswersReadableAttribute[]

Answer readable attributes list

Include only specified fields of Answer in response

fields[candidates]CandidatesReadableAttribute[]

Candidate readable attributes list

Include only specified fields of Candidate in response

fields[comments]CommentsReadableAttribute[]

Comment readable attributes list

Include only specified fields of Comment in response

fields[custom_attributes]CustomAttributesReadableAttribute[]

Custom Attribute readable attributes list

Include only specified fields of Custom Attribute in response

fields[structured_section_responses]StructuredSectionResponsesReadableAttribute[]

Structured Section Response readable attributes list

Include only specified fields of Structured Section Response in response

fields[user_scorecards]UserScorecardsReadableAttribute[]

User Scorecard readable attributes list

Include only specified fields of User Scorecard in response

filter[candidate_id]string

Candidate id filter

Filter records by Candidate id

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

filter[external_system_reference]string[]

External system reference filter

Filter records by External system reference

filter[search]string[]

Search filter

Filter records by Search

sortstring[]

Job Seeker sortable attributes

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

Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'

Example:count

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

Response

OK: Job Seekers collection