---
title: "Get Client Onboardings"
method: GET
path: "/compliance/v1/companies/b6001/clientOnboardings"
tags: ["Client Onboarding"]
---

# Get Client Onboardings

`GET /compliance/v1/companies/b6001/clientOnboardings`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/compliance/v1/companies/b6001/clientOnboardings`
- Auth: API key in header `Authorization`

> 🚧 Partner Restricted
> 
> The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested in exploring partnership opportunities, please contact us at [Techpartnerships@paylocity.com](mailto:Techpartnerships@paylocity.com) 

**Summary Description**

This endpoint allows partners to get their onboarded companies with an option of filtering by companyId and status.

## Query parameters

- `filter` string
- `limit` integer
- `offset` integer

## Headers

- `testMode` boolean
- `Authorization` string, required

## Response `200`

OK - Returns client onboardings.

- OnboardingDtoPaginatedResult: Represents a single page of results returned from a paginated endpoint.
  - `count` integer: Optional total number of items available across all pages when requested.
  - `offset` integer: Zero-based index of the first item returned in the current page.
  - `limit` integer: Maximum number of items requested per page.
  - `items` OnboardingDto[], nullable: Items retrieved for the current page.
    - `companyId` string, nullable
    - `status` 'InProgress' | 'Approved' | 'Rejected' | 'Suspended'

## Other responses

- `400`: Bad Request - Returns the details of the error.
- `401`: Unauthorized

---

[API](https://skmtc.dev/paylocity/apis/background-check-api.md) - [All operations](https://skmtc.dev/paylocity/apis/background-check-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/background-check-api/revisions/8d585de5e05e?raw)