v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Job Application API:Job Applications

Find job applications

get/applications

Query parameters

ApplicationIdinteger[]

Application Id

CandidateIdinteger[]

Candidate Id

JobIdinteger[]

Job Id

AdIdinteger[]

Job Ad Id

StatusIdinteger[]

Job application status

JobTitlestring
Activeboolean

Search for active job applications

Rejectedboolean

Search for rejected job applications

Review.StageJobApplicationReviewStage[]

Search for job applications at the specified review stage.

Review.UserIdinteger[]

Search for job applications submitted for review by the specified users.

Review.ContactIdinteger[]

Search for job applications submitted for review to the specified hiring manager contacts

Review.SubmittedAtstring[]

Search for job applications submitted for review at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Review.ReviewedAtstring[]

Search for job applications reviewed at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Keywordsstring

Search for key words within the applicant's resume

PartnerAction.ActionIdstring[]

Unique identifier for partner actions

PartnerAction.Referencestring[]

Partner supplied unique reference for the action

PartnerAction.StagePartnerActionStage[]

Include partner actions at a specific stage

PartnerAction.SubmittedAtstring[]

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

FolderIdinteger[]

Search in specific folders

CreatedAtstring[]

Search for job applications created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedByinteger[]

User Id - search for job applications last updated by the specified user(s)

UpdatedAtstring[]

Search for job applications updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Sortstring[]

Sort the results by one or multiple fields, prefix with "-" to sort descending.<br /> Fields available for sorting are: createdAt, status.name, review.stage, review.submittedAt, review.reviewedAt

Fieldsstring[]

Additional fields to include with the results. Fields available to include are: partnerActions

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of job applications matching the specified criteria

totalCountinteger required