Theme switcher

Placements

Header Parameters

Content-Typestring
Authorizationstring

Query Parameters

limitinteger

Number of placements to return per page. Must be between 5 and 50

jobIdstring

Filters placements by job ID. These IDs can be retrieved from the getJobPostingsList endpoint.

jobIdEncryptedstring

Alternative parameter to filter placements by job posting. Accepts encrypted job ID

clientIdstring

Filters placements by client ID. These IDs can be retrieved from the getClientsList endpoint.

businessUnitIdstring

Filters placements by business unit IDs. These IDs can be retrieved from the getBusinessUnitsList endpoint.

jobSeekerIdstring

Filters placements by applicant ID. These IDs can be retrieved from the getApplicantsList endpoint.

placementStatusstring

Filters placements by placement status

isConfirmationstring

Filters placements by confirmation status. "1" for confirmed placements, "0" for unconfirmed

createdBystring

Filters placements by user ID. These IDs can be retrieved from the getUsersList endpoint.

modifiedBystring

Filters placements by user ID. These IDs can be retrieved from the getUsersList endpoint.

fromDatestring

Start date for date range filtering. Must be used with filter parameter

toDatestring

End date for date range filtering. Must be used with filter parameter

filterstring

Specifies which date field to filter by when using fromDate/toDate. Options include creation date, modification date, estimated start date, or job start date

sortBystring

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).

sortOrderstring

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.

employeeTypeinteger

Filters placements by employee type ID. These IDs can be retrieved from the getEmploymentTypesList endpoint.

Response

200
Object

Response Attributes

idstring
job_idstring
placement_idstring
job_start_datestring
job_end_datestring
client_namestring
created_bystring
createdstring
revenue_typestring
business_unit_idnumber
is_confirmationnumber
modifiedstring
modified_bystring
per_diemstring
client_idstring
employee_namestring
emailstring
employee_numberstring
job_seeker_idstring
placement_statusstring
400
Object
Invalid parameters or filters.
401
Object
Please provide the access token.
403
Object
Your company access is temporarily disabled.
404
Object
Data not found.
429
Object
Request limit exceeded. Please try again later.
Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?