--- title: "Get Placements for a Job" method: GET path: "/v1/job/{jobId}/placements" tags: ["Jobs"] --- # Get Placements for a Job `GET /v1/job/{jobId}/placements` ## Request - Base URL: `https://api.avionte.com/front-office` - URL: `https://api.avionte.com/front-office/v1/job/{jobId}/placements` - Auth: one of: - API key in header `x-api-key` - HTTP bearer Returns a list of placements and their details for the specified job ID. ## Path parameters - `jobId` string, required ## Headers - `RequestId` string, uuid: Unique request identifier in UUID format used to correlate request data to log entries and events. - `FrontOfficeTenantId` integer - `Tenant` string ## Response `200` A list of placements for the specified job. - Placement[] - `id` integer: The identifier for the placement. - `talentId` integer: The identifier for the talent. - `jobId` integer: The identifier for the job. - `extensionId` integer: The identifier for the current active placement extension. - `extensionIdList` integer[]: The list of identifiers for all of the placement extensions for the placement. - `startDate` string, date-time: The placement start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `endDate` string, date-time: The placement end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `isActive` boolean: An indication of whether the placement is active or not. - `payRates` Rate - `regular` number: The regular rate value. - `overtime` number: The overtime rate value. - `doubletime` number: The double time rate value. - `billRates` Rate - `regular` number: The regular rate value. - `overtime` number: The overtime rate value. - `doubletime` number: The double time rate value. - `commissionUsers` CommissionUser[]: A list of commission recipients and their details. - `commissionUserType` string: The commission user type. - `userId` integer: User ID of the commission recipient. - `userFullName` string: The full name of the commission recipient. - `commissionPercent` number: The commission percentage allocated to the recipient. - `estimatedGrossProfit` number: Estimated gross profit. - `employmentType` 'Temporary' | 'Permanent': Employment types available for selection. - `frontOfficeId` integer: The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID. - `isPermanentPlacementExtension` boolean: An indication of whether the placement is permanent or not. - `payBasis` string: The pay basis for the placement. - `hiredDate` string, date-time: The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `placementAdditionalRates` PlacementAdditionalRates[]: A list of additional rates and their details. - `leaveRuleId` integer: The identifier for the leave rule. - `leaveTypeID` integer: The identifier for the leave type or additional transaction type. - `payRate` number: The additional transaction pay rate value. - `billRate` number: The additional transaction bill rate value. - `inputType` string: The input type of the additional rate. Valid values are Hours, Punches and Units. - `payBillTerm` integer: The identifier for the pay and bill term for the additional rate. Valid values are 1 for Paid & Billed and 2 for Paid NOT Billed. - `leaveType` string: The leave or additional transaction type. - `endReasonId` integer: The identifier for the end reason. - `endReason` string: The reason for ending the placement. - `performanceId` integer: The identifier for the performance. - `performance` string: The performance rating recorded for ending the placement. - `enteredByUserId` integer: The identifier for the user who entered the placement record. - `enteredByUser` string: The email of the user who entered the placement record. - `recruiterUserId` integer: The identifier for the recruiter user. - `recruiterUser` string: The email of the recruiter user. - `customDetails` PlacementDetail[]: A list of custom details. - `id` integer: The identifier for the placement detail. - `placementId` integer: The identifier for the placement. - `jobId` integer: The identifier for the job. - `talentId` integer: The identifier for the talent. - `name` string: The name of the detail. - `value` string: The value of the detail. The format of the value depends on the type of detail. If the type is 'checkbox', the value can be 'Yes' or 'No'. If the type is 'minmax', the value can be a string representing the minimum value, like '10'. If the type is 'numeric', the value can be a number like '15'. If the type is 'time', the value can be a time string like '08:00'. If the type is 'text', the value can be a string like 'Business Casual'. - `additionalValue` string: An additional value needed for the detail. If the type is 'minmax', the value can be a string representing the maximum value, like '100'. - `type` string: The type of detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'. - `createdByUserId` integer: The identifier for the user who created the placement. - `createdDate` string, date-time: The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546. - `hasNoEndDate` boolean: An indication of whether the placement has an end date or not. - `originalStartDate` string, date-time: The original start date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `finalEndDate` string, date-time: The final end date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `origin` string: The origin of the placement. - `reqEmploymentType` string: The employment type code for the placement. - `reqEmploymentTypeName` string: The display name of the employment type for the placement. - `shiftName` string: Description of the configured job shift. - `placementScheduleShifts` PlacementScheduleShift[]: The Schedule Shifts for the placement. This property is specific to Avionté 24/7. - `id` integer: The identifier for the placement schedule shift. - `weekDay` integer: The identifier for the shift weekday, starting with 0 for Sunday. - `duration` integer: The minutes for duration. - `startTime` string, duration: Hours and minutes for start time in 24-hour local time. - `date` string, date-time: The date for the shift. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00. - `createdDate` string, date-time: The date when the placement was created. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `updatedDate` string, date-time: The date when the placement was udpated. The field follows the YYYY-MM-DDTHH:mm:ss.sssZ format for UTC time. For example, 2024-12-01T14:30:00.546Z. - `status` 'COMMITTED' | 'CANCELED': The status of the placement schedule shift. - `placementScheduleDays` PlacementScheduleDays - `startTimeLocal` string: The local start time for the shifts in a 24-hour format. - `endTimeLocal` string: The local end time for the shifts in a 24-hour format. - `shiftScheduleDays` ShiftScheduleDays - `monday` boolean: An indication of whether Monday is part of a shift schedule or not. - `tuesday` boolean: An indication of whether Tuesday is part of a shift schedule or not. - `wednesday` boolean: An indication of whether Wednesday is part of a shift schedule or not. - `thursday` boolean: An indication of whether Thursday is part of a shift schedule or not. - `friday` boolean: An indication of whether Friday is part of a shift schedule or not. - `saturday` boolean: An indication of whether Saturday is part of a shift schedule or not. - `sunday` boolean: An indication of whether Sunday is part of a shift schedule or not. - `approvers` PlacementApprover[]: The list of approvers attached to the placement across all extensions. Empty array when no approvers exist. - `extensionId` integer: The placement extension this approver record is attached to. - `approverUserId` integer: The User id of the approver. Non-zero for both HCM User and Contact rows — every Contact used as an approver has a linked Manager User. - `approverEntityId` integer: The approver's entity id. Equals approverUserId when approverEntityType = "HCM User"; equals the Contact record id when approverEntityType = "Contact". Always populated. - `approverEntityType` 'HCM User' | 'Contact': Discriminator for the approver's entity. - `approverType` 'Timesheets' | 'Expenses' | 'Both': What the approver approves. - `flsaClassification` 'Exempt' | 'NonExempt' | 'None': The Fair Labor Standards Act (FLSA) classification for the placement, which determins the talent's eligibility for overtime pay. Valid values are `Exempt`, `NonExempt`, and `None`. - `workScheduleType` 'Full-Time' | 'Part-Time' | 'Intermittent' | 'None': The expected work schedule for the placement. Valid values are `Full-Time`, `Part-Time`, `Intermittent`, and `None`. - `remoteWork` boolean: An indication of whether the placement is a remote work arrangement. - `currency` string: The currency the placement's rates are quoted in. Valid values are USD and CAD. Null or empty indicates no currency has been set for the placement. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Access Denied - `404`: Not found - `405`: Unsupported method - `406`: Unsupported format(s) indicated by Accept header - `415`: Unsupported format(s) indicated by the Content-Type header - `429`: Too many requests - `500`: An unexpected error occurred - `502`: Service Unavailable - `504`: Gateway Timeout --- [API](https://skmtc.dev/avionte/apis/bold-front-office-api.md) - [All operations](https://skmtc.dev/avionte/apis/bold-front-office-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/bold-front-office-api/revisions/bd5996cbaa0f?raw)