---
title: "Get a placement"
method: GET
path: "/placements/{placementId}"
tags: ["Placement API:Placements"]
---

# Get a placement

`GET /placements/{placementId}`

## Path parameters

- `placementId` integer, required

## Query parameters

- `Embed` string[]

## Response `200`

Requested placement details

- PlacementRepresentation
  - `placementId` integer, required
  - `jobTitle` string, nullable
  - `job` JobOrderTitleModel
    - `jobId` integer, required
    - `jobTitle` string, nullable
    - `location` JobOrderLocationModel
      - `locationId` integer, required
      - `name` string, required
      - `area` JobOrderLocationAreaModel
        - `areaId` integer, required
        - `name` string, required
    - `company` CompanyNameModel
      - `companyId` integer, required — Unique identifier for the company
      - `name` string, nullable — Company name
      - `status` StatusModel
        - `statusId` integer, required
        - `name` string, required
        - `active` boolean
        - `default` boolean
      - `owner` UserNameModel
        - `userId` integer, required
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `position` string, nullable
        - `email` string, nullable
        - `phone` string, nullable
        - `mobile` string, nullable
        - `inactive` boolean
        - `deleted` boolean
    - `contact` ContactNameModel
      - `contactId` integer, required — Unique identifier for the contact
      - `firstName` string, nullable — First name
      - `lastName` string, nullable — Last name
      - `position` string, nullable — Position or job title
      - `salutation` string, nullable — Salutation/honorific/title
      - `unsubscribed` boolean
      - `email` string, nullable — Primary email address
      - `phone` string, nullable — Phone number
      - `mobile` string, nullable — Mobile/cell number
      - `mobileNormalized` string, nullable — Mobile/cell normalized number
      - `inactive` boolean — Contact is no longer with the company
      - `status` StatusModel
        - `statusId` integer, required
        - `name` string, required
        - `active` boolean
        - `default` boolean
      - `owner` UserNameModel
        - `userId` integer, required
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `position` string, nullable
        - `email` string, nullable
        - `phone` string, nullable
        - `mobile` string, nullable
        - `inactive` boolean
        - `deleted` boolean
    - `status` StatusModel
      - `statusId` integer, required
      - `name` string, required
      - `active` boolean
      - `default` boolean
    - `source` string, nullable
    - `owner` UserNameModel
      - `userId` integer, required
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `position` string, nullable
      - `email` string, nullable
      - `phone` string, nullable
      - `mobile` string, nullable
      - `inactive` boolean
      - `deleted` boolean
  - `candidate` CandidatePlacementModel
    - `candidateId` integer, required — Candidate Id
    - `firstName` string, nullable — First name
    - `lastName` string, nullable — Last name
    - `email` string, nullable — Primary email address
    - `phone` string, nullable — Contact phone number
    - `mobile` string, nullable — Mobile/cell number
    - `mobileNormalized` string, nullable — Mobile/cell normalized number
    - `contactMethod` string, nullable — Preferred contact method
    - `salutation` string, nullable — Salutation/honorific/title
    - `unsubscribed` boolean
    - `address` AddressModel
      - `street` string[], nullable
      - `city` string, nullable
      - `state` string, nullable
      - `postalCode` string, nullable
      - `country` string, nullable
      - `countryCode` string, nullable
    - `status` StatusModel
      - `statusId` integer, required
      - `name` string, required
      - `active` boolean
      - `default` boolean
    - `rating` string, nullable — Internal rating of the candidate
    - `source` string, nullable — The source of the candidate
    - `seeking` 'Yes' | 'Maybe' | 'No', string
    - `dateOfBirth` string, date, nullable — Candidate date of birth available ([ISO full-date](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6))
  - `approved` boolean
  - `approvedAt` string, date-time, nullable
  - `type` 'Permanent' | 'Contract' | 'Temporary' | 'Credit', string, required
  - `status` StatusModel
    - `statusId` integer, required
    - `name` string, required
    - `active` boolean
    - `default` boolean
  - `startDate` string, date, nullable — Date employment begins
  - `endDate` string, date, nullable — Date a contract or temporary employment ends
  - `workShift` PlacementWorkShiftModel
    - `startTime` string, time, nullable
    - `endTime` string, time, nullable
    - `workDays` string[], nullable
  - `summary` string, nullable
  - `company` CompanyNameModel
    - `companyId` integer, required — Unique identifier for the company
    - `name` string, nullable — Company name
    - `status` StatusModel
      - `statusId` integer, required
      - `name` string, required
      - `active` boolean
      - `default` boolean
    - `owner` UserNameModel
      - `userId` integer, required
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `position` string, nullable
      - `email` string, nullable
      - `phone` string, nullable
      - `mobile` string, nullable
      - `inactive` boolean
      - `deleted` boolean
  - `contact` ContactNameModel
    - `contactId` integer, required — Unique identifier for the contact
    - `firstName` string, nullable — First name
    - `lastName` string, nullable — Last name
    - `position` string, nullable — Position or job title
    - `salutation` string, nullable — Salutation/honorific/title
    - `unsubscribed` boolean
    - `email` string, nullable — Primary email address
    - `phone` string, nullable — Phone number
    - `mobile` string, nullable — Mobile/cell number
    - `mobileNormalized` string, nullable — Mobile/cell normalized number
    - `inactive` boolean — Contact is no longer with the company
    - `status` StatusModel
      - `statusId` integer, required
      - `name` string, required
      - `active` boolean
      - `default` boolean
    - `owner` UserNameModel
      - `userId` integer, required
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `position` string, nullable
      - `email` string, nullable
      - `phone` string, nullable
      - `mobile` string, nullable
      - `inactive` boolean
      - `deleted` boolean
  - `source` PlacementSourceModel
    - `placement` string, nullable — The source of candidate that lead to this placement
    - `candidate` string, nullable — The original source of the candidate
  - `workplaceAddress` CompanyAddressModel
    - `addressId` string, uuid, required
    - `name` string, nullable
    - `street` string[], nullable
    - `city` string, nullable
    - `state` string, nullable
    - `postalCode` string, nullable
    - `country` string, nullable
    - `countryCode` string, nullable
    - `phone` string, nullable
    - `fax` string, nullable
    - `url` string, uri, nullable
  - `paymentType` string, nullable
  - `salary` PlacementSalaryModel
    - `base` number, double, nullable
    - `superannuation` number, double, nullable
    - `benefits` number, double, nullable
    - `total` number, double, nullable
    - `fee` number, double, nullable
  - `contractRate` PlacementContractRateModel
    - `ratePer` 'Hour' | 'Day' | 'Week' | 'Month', string
    - `hoursPerWeek` number, double, nullable
    - `daysPerWeek` number, double, nullable
    - `clientRate` number, double, nullable
    - `candidateRate` number, double, nullable
    - `onCostsType` 'Fixed' | 'Percent', string
    - `onCosts` number, double, nullable
    - `netMargin` number, double, nullable
  - `rates` PlacementRateModel[], nullable
    - `name` string, nullable
    - `type` string, nullable
    - `default` boolean
    - `displayIndex` integer
    - `payRate` number, double
    - `chargeRate` number, double
    - `chargeCurrency` string, nullable
  - `award` string, nullable
  - `industryCode` string, nullable
  - `chargeCurrency` string, nullable
  - `payCurrency` string, nullable
  - `feeSplit` 'Fixed' | 'Percent', string
  - `billing` PlacementBillingModel
    - `contact` ContactNameModel
      - `contactId` integer, required — Unique identifier for the contact
      - `firstName` string, nullable — First name
      - `lastName` string, nullable — Last name
      - `position` string, nullable — Position or job title
      - `salutation` string, nullable — Salutation/honorific/title
      - `unsubscribed` boolean
      - `email` string, nullable — Primary email address
      - `phone` string, nullable — Phone number
      - `mobile` string, nullable — Mobile/cell number
      - `mobileNormalized` string, nullable — Mobile/cell normalized number
      - `inactive` boolean — Contact is no longer with the company
      - `status` StatusModel
        - `statusId` integer, required
        - `name` string, required
        - `active` boolean
        - `default` boolean
      - `owner` UserNameModel
        - `userId` integer, required
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `position` string, nullable
        - `email` string, nullable
        - `phone` string, nullable
        - `mobile` string, nullable
        - `inactive` boolean
        - `deleted` boolean
    - `address` CompanyAddressModel
      - `addressId` string, uuid, required
      - `name` string, nullable
      - `street` string[], nullable
      - `city` string, nullable
      - `state` string, nullable
      - `postalCode` string, nullable
      - `country` string, nullable
      - `countryCode` string, nullable
      - `phone` string, nullable
      - `fax` string, nullable
      - `url` string, uri, nullable
    - `email` string, nullable
    - `orderRef` string, nullable — PO Number/Reference
    - `invoiceRef` string, nullable — Invoice Number/Reference
    - `terms` string, nullable — Billing payment terms
    - `dueDate` string, date, nullable — Payment due date
  - `export` PlacementExportModel
    - `payroll` boolean, nullable — Placement has been selected for export to a payroll service
    - `timesheets` boolean, nullable — Placement has been selected for export to a timesheet service
    - `approvers` PlacementApproverModel[], nullable — Timesheet/payroll approver contacts
      - `primary` boolean
      - `contactId` integer, required — Unique identifier for the contact
      - `firstName` string, nullable — First name
      - `lastName` string, nullable — Last name
      - `position` string, nullable — Position or job title
      - `salutation` string, nullable — Salutation/honorific/title
      - `unsubscribed` boolean
      - `email` string, nullable — Primary email address
      - `phone` string, nullable — Phone number
      - `mobile` string, nullable — Mobile/cell number
      - `mobileNormalized` string, nullable — Mobile/cell normalized number
      - `inactive` boolean — Contact is no longer with the company
      - `status` StatusModel
        - `statusId` integer, required
        - `name` string, required
        - `active` boolean
        - `default` boolean
      - `owner` UserNameModel
        - `userId` integer, required
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `position` string, nullable
        - `email` string, nullable
        - `phone` string, nullable
        - `mobile` string, nullable
        - `inactive` boolean
        - `deleted` boolean
    - `onboarding` boolean, nullable — Placement has been selected for export to an onboarding service
    - `onboardingManagers` PlacementApproverModel[], nullable — Onboarding manager contacts
      - `primary` boolean
      - `contactId` integer, required — Unique identifier for the contact
      - `firstName` string, nullable — First name
      - `lastName` string, nullable — Last name
      - `position` string, nullable — Position or job title
      - `salutation` string, nullable — Salutation/honorific/title
      - `unsubscribed` boolean
      - `email` string, nullable — Primary email address
      - `phone` string, nullable — Phone number
      - `mobile` string, nullable — Mobile/cell number
      - `mobileNormalized` string, nullable — Mobile/cell normalized number
      - `inactive` boolean — Contact is no longer with the company
      - `status` StatusModel
        - `statusId` integer, required
        - `name` string, required
        - `active` boolean
        - `default` boolean
      - `owner` UserNameModel
        - `userId` integer, required
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `position` string, nullable
        - `email` string, nullable
        - `phone` string, nullable
        - `mobile` string, nullable
        - `inactive` boolean
        - `deleted` boolean
  - `custom` CustomFieldValueModel[], nullable
    - `fieldId` integer, required
    - `name` string, required
    - `type` 'Text' | 'List' | 'Date' | 'Lookup' | 'Url', string, required — The type of value a custom field expects
    - `value` unknown
  - `owner` UserNameModel
    - `userId` integer, required
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `position` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `mobile` string, nullable
    - `inactive` boolean
    - `deleted` boolean
  - `recruiters` PlacementRecruiterModel[], nullable
    - `feeSplit` number, double, nullable
    - `userId` integer, required
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `position` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `mobile` string, nullable
    - `inactive` boolean
    - `deleted` boolean
  - `partnerActions` PartnerActionStageModel[], nullable
    - `actionId` string, uuid
    - `actionName` string, nullable
    - `reference` string, nullable — Unique partner defined reference/identifier for the action
    - `stage` 'Submitted' | 'InProgress' | 'Completed' | 'Rejected' | 'Cancelled', string
    - `status` string, nullable — Partner defined progress status message for the action
    - `result` PartnerActionResultModel
      - `score` integer, nullable — Optional partner score for the action result
      - `url` string, uri, nullable — Optional partner defined URL for the action result
      - `urlType` 'Popup' | 'Page', string
    - `submittedAt` string, date-time
    - `submittedBy` UserNameModel
      - `userId` integer, required
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `position` string, nullable
      - `email` string, nullable
      - `phone` string, nullable
      - `mobile` string, nullable
      - `inactive` boolean
      - `deleted` boolean
    - `updatedAt` string, date-time
    - `updatedBy` UserNameModel
      - `userId` integer, required
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `position` string, nullable
      - `email` string, nullable
      - `phone` string, nullable
      - `mobile` string, nullable
      - `inactive` boolean
      - `deleted` boolean
  - `createdBy` UserNameModel
    - `userId` integer, required
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `position` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `mobile` string, nullable
    - `inactive` boolean
    - `deleted` boolean
  - `createdAt` string, date-time, nullable
  - `updatedBy` UserNameModel
    - `userId` integer, required
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `position` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `mobile` string, nullable
    - `inactive` boolean
    - `deleted` boolean
  - `updatedAt` string, date-time, nullable
  - `links` PlacementLinks
    - `self` string, uri, nullable
    - `extendsPlacement` string, uri, nullable — Extends placement
    - `extendedByPlacement` string, uri, nullable — Extended by placement
    - `creditsPlacement` string, uri, nullable — Credits placement
    - `creditedByPlacement` string, uri, nullable — Credited by placement
    - `application` string, uri, nullable — Job application
    - `attachments` string, uri, nullable — Attachments
    - `notes` string, uri, nullable — Notes

## Other responses

- `404` — Requested placement was not found

---

[API](https://skmtc.net/jobadder/apis/jobadder-api.md) · [All operations](https://skmtc.net/jobadder/apis/jobadder-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jobadder/jobadder-api/versions/9f43f6a6ee6e/schema)