Placements
Header Parameters
Query Parameters
Number of placements to return per page. Must be between 5 and 50
Filters placements by job ID. These IDs can be retrieved from the getJobPostingsList endpoint.
Alternative parameter to filter placements by job posting. Accepts encrypted job ID
Filters placements by client ID. These IDs can be retrieved from the getClientsList endpoint.
Filters placements by business unit IDs. These IDs can be retrieved from the getBusinessUnitsList endpoint.
Filters placements by applicant ID. These IDs can be retrieved from the getApplicantsList endpoint.
Filters placements by placement status
Filters placements by confirmation status. "1" for confirmed placements, "0" for unconfirmed
Filters placements by user ID. These IDs can be retrieved from the getUsersList endpoint.
Filters placements by user ID. These IDs can be retrieved from the getUsersList endpoint.
Start date for date range filtering. Must be used with filter parameter
End date for date range filtering. Must be used with filter parameter
Specifies which date field to filter by when using fromDate/toDate. Options include creation date, modification date, estimated start date, or job start date
Determines the sorting direction, where desc applies descending order and asc applies ascending order; defaults to descending if not specified (e.g., sortBy=id&sortOrder=asc).
Specifies the field used to sort results; accepts only supported fields per endpoint and defaults to a predefined field if not provided (e.g., sortBy=id&sortOrder=asc). Supports sorting by id, modified, created; defaults to descending order on id.
Filters placements by employee type ID. These IDs can be retrieved from the getEmploymentTypesList endpoint.