---
title: "Find placements"
method: GET
path: "/placements"
tags: ["Placement API:Placements"]
---

# Find placements

`GET /placements`

## Query parameters

- `PlacementId` integer[]
- `Type` PlacementType[]
- `PartnerAction.ActionId` string[]
- `PartnerAction.Reference` string[]
- `PartnerAction.Stage` PartnerActionStage[]
- `PartnerAction.SubmittedAt` string[]
- `StatusId` integer[]
- `Candidate.CandidateId` integer[]
- `Candidate.Name` string
- `CandidateId` integer[]
- `Company.CompanyId` integer[]
- `Company.Name` string
- `CompanyId` integer[]
- `JobId` integer[]
- `ApplicationId` integer[]
- `StartDate` string[]
- `EndDate` string[]
- `FolderId` integer[]
- `UserId` integer[]
- `OwnerUserId` integer[]
- `RecruiterUserId` integer[]
- `CreatedBy` integer[]
- `CreatedAt` string[]
- `UpdatedBy` integer[]
- `UpdatedAt` string[]
- `Approved` boolean
- `ApprovedBy` integer[]
- `ApprovedAt` string[]
- `Export` FindPlacementByExport[]
- `Timesheet.Period` string[]
- `Fields` string[]
- `Embed` string[]
- `Offset` integer
- `Limit` integer

## Response `200`

List of placements matching the specified criteria

- PlacementListRepresentation
  - `items` PlacementSummaryModel[], nullable
    - `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
    - `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
  - `totalCount` integer, required
  - `links` PageLinks
    - `first` string, uri, nullable
    - `prev` string, uri, nullable
    - `next` string, uri, nullable
    - `last` string, uri, nullable

---

[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/revisions/9f43f6a6ee6e/schema)