v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Requisition API:Requisitions

Find requisitions

get/requisitions

Query parameters

RequisitionIdinteger[]

Requisition Id

CompanyIdinteger[]

Company Id

StatusRequisitionStatus[]
HiringManager.ContactIdinteger[]
HiringManager.Namestring
Approver.ContactIdinteger[]

Find requisitions by approver contact id

Approver.Namestring
Approver.Pendingboolean

Find requisitions pending approval by contacts specified in approver.contactId

UserIdinteger[]

User Id - search for requisitions by owner or associated recruiter

OwnerUserIdinteger[]

User Id - search for requisitions by owner

RecruiterUserIdinteger[]

User Id - search for requisitions by associated recruiters

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.

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.

Sortstring[]

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

Fieldsstring[]

Additional fields to include with the results.<br /> Fields available to include are: workflow

Embedstring[]

Linked resources to embed in the results<br /> Resources available are: self, notes

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

totalCountinteger required