v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Job API:Jobs

Find jobs

get/jobs

Query parameters

JobIdinteger[]

Job Id

JobTitlestring

Job title

Company.CompanyIdinteger[]

Companies by Id

Company.Namestring

Company name

CompanyIdinteger[]

Alias for company.companyId

ContactIdinteger[]

Contact Id

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.

StatusIdinteger[]

Job status

Activeboolean

Search for active/open jobs

UserFavouriteboolean

Search for the user's favourite jobs

FolderIdinteger[]

Search in specific folders

UserIdinteger[]

User Id - search for jobs by owner or associated recruiter

OwnerUserIdinteger[]

User Id - search for jobs by owner

RecruiterUserIdinteger[]

User Id - search jobs by associated recruiters

CreatedByinteger[]

User Id - search for jobs created by the specified user(s)

CreatedAtstring[]

Search for jobs 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 jobs last updated by the specified user(s)

UpdatedAtstring[]

Search for jobs 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.

ClosedByinteger[]

User Id - search for jobs last closed by the specified user(s)

ClosedAtstring[]

Search for jobs closed 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: jobTitle, status.name, createdAt, updatedAt, closedAt

Fieldsstring[]

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

Embedstring[]

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

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 jobs matching the specified criteria

totalCountinteger required