v1
latestOpenAPI 3.0.12026-08-063985821.3 MBFind placements
Query parameters
Placement Id
Placement Type
Unique identifier for partner actions
Partner supplied unique reference for the action
Include partner actions at a specific stage
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.
Placement status
Candidate Id
Candidate name
Alias for candidate.candidateId
Companies by Id
Company name
Alias for company.companyId
Job Id
Job Application Id
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.
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.
Search in specific folders
User Id - search for placements by owner or associated recruiter
User Id - search for placements by owner
User Id - search placements by associated recruiters
User Id - search for placements created by the specified user(s)
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.
User Id - search for placements last updated by the specified user(s)
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.
Search for approved placements
User Id - search for placements approved by the specified user(s)
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.
Search for placements that have been flagged by the user for export to integration partners.
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.
Additional fields to include with the results. Fields available to include are: partnerActions
Embed related resources.<br /> Resources available to embed are: self, notes
The index of the first entry to return from the resource collection
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