---
title: "Get Onboarding Status"
method: GET
path: "/apiHub/security/v1/companies/b6001/clientOnboardings"
tags: ["Client Onboarding"]
---

# Get Onboarding Status

`GET /apiHub/security/v1/companies/b6001/clientOnboardings`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/apiHub/security/v1/companies/b6001/clientOnboardings`
- Auth: none declared

> 🚧 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, [please reach out to our team](https://www.paylocity.com/contact/partner-form/) to discuss partnership opportunities.

**Summary Description**

The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This endpoint allows partners to get their onboardings with an option of filtering by companyId and status.

## Query parameters

- `filter` string
- `limit` integer
- `offset` integer
- `includeTotalCount` boolean

## Headers

- `testMode` boolean

## Response `200`

OK - Returns client onboardings.

- ClientOnboardingDtoDtoPage
  - `items` ClientOnboardingDto[], nullable
    - `companyId` string, nullable
    - `status` 'InProgress' | 'Approved' | 'Rejected' | 'Suspended'
  - `totalCount` integer, nullable

## Other responses

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

---

[API](https://skmtc.dev/paylocity/apis/partner-onboarding-api.md) - [All operations](https://skmtc.dev/paylocity/apis/partner-onboarding-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/partner-onboarding-api/revisions/65f50fccface?raw)