---
title: "Get all Preboarding Candidates"
method: GET
path: "/v1/hire/preboarding/candidates"
tags: ["PreboardingAPI"]
---

# Get all Preboarding Candidates

`GET /v1/hire/preboarding/candidates`

Get all Preboarding Candidates

## Query parameters

- `candidateIds` string
- `stage` string
- `status` string
- `lastModified` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success

- PreboardingCandidateDTOPagedResult
  - `items` PreboardingCandidateDTO[], nullable
    - `id` string, nullable — Gets or sets the identifier.
    - `firstName` string, nullable — Gets or sets the FirstName.
    - `middleName` string, nullable — Gets or sets the MiddleName.
    - `lastName` string, nullable — Gets or sets the lastName.
    - `email` string, nullable — Gets or sets Email.
    - `countryCode` string, nullable — Gets or sets Country code.
    - `mobileNumber` string, nullable — Gets or sets MobileNumber.
    - `jobtitle` string, nullable — Gets or sets Jobtitle.
    - `gender` 0 | 1 | 2 | 3
    - `department` string, nullable — Gets or sets Department.
    - `workLocation` string, nullable — Gets or sets WorkLocation.
    - `expectedDateOfJoining` string, date-time, nullable — Gets or sets ExpectedDateOfJoining.
    - `stage` 0 | 1 | 2 | 3 | 4 | 5
    - `status` 0 | 1 | 2 | 3 | 4 | 5
  - `page` integer
  - `pageSize` integer
  - `totalItems` integer
  - `totalPages` integer
  - `sortBy` string, nullable
  - `sortOrder` string, nullable

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/keka/apis/keka-api.md) · [All operations](https://skmtc.net/keka/apis/keka-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keka/keka-api/revisions/907ea395c885/schema)