v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Placement API:Placements

Find placements

get/placements

Query parameters

PlacementIdinteger[]

Placement Id

TypePlacementType[]

Placement Type

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[]

Placement status

Candidate.CandidateIdinteger[]

Candidate Id

Candidate.Namestring

Candidate name

CandidateIdinteger[]

Alias for candidate.candidateId

Company.CompanyIdinteger[]

Companies by Id

Company.Namestring

Company name

CompanyIdinteger[]

Alias for company.companyId

JobIdinteger[]

Job Id

ApplicationIdinteger[]

Job Application Id

StartDatestring[]

Search for placements starting in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

EndDatestring[]

Search for placements ending in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

FolderIdinteger[]

Search in specific folders

UserIdinteger[]

User Id - search for placements by owner or associated recruiter

OwnerUserIdinteger[]

User Id - search for placements by owner

RecruiterUserIdinteger[]

User Id - search placements by associated recruiters

CreatedByinteger[]

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

CreatedAtstring[]

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

UpdatedAtstring[]

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

Approvedboolean

Search for approved placements

ApprovedByinteger[]

User Id - search for placements approved by the specified user(s)

ApprovedAtstring[]

Search for placements approved 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.

ExportFindPlacementByExport[]

Search for placements that have been flagged by the user for export to integration partners.

Timesheet.Periodstring[]

Find placements with timesheets in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

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

totalCountinteger required