---
updatedAt: 2026-06-18T14:54:41.000Z
agentTools:
  siteIndex: https://developer.paylocity.com/llms.txt
  projectIndex: https://developer.paylocity.com/integrations/llms.txt
---

# Get Onboarding Status

> 🚧 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.


# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Partner Onboarding API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "dc1demogwext.paylocity.com"
    }
  ],
  "paths": {
    "/apiHub/security/v1/companies/b6001/clientOnboardings": {
      "get": {
        "tags": [
          "Client Onboarding"
        ],
        "summary": "Get Onboarding Status",
        "description": "> 🚧 Partner Restricted\n> \n> 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.\n\n**Summary Description**\n\nThe 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.\n",
        "x-explorer-enabled": false,
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "The filtering expression ( e.g. companyId eq b6001, status eq Approved ).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Limit.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 50
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Offset.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "includeTotalCount",
            "in": "query",
            "description": "Include total items count into response as a header.",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "testMode",
            "in": "header",
            "description": "If true all responses are mocked and generated randomly.",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Returns client onboardings.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientOnboardingDtoDtoPage"
                },
                "examples": {
                  "Multiple Onboardings": {
                    "value": {
                      "items": [
                        {
                          "companyId": "A00123",
                          "status": "Approved"
                        },
                        {
                          "companyId": "B00456",
                          "status": "InProgress"
                        },
                        {
                          "companyId": "C00789",
                          "status": "Rejected"
                        }
                      ],
                      "totalCount": 3
                    }
                  },
                  "Filtered by Status - Approved": {
                    "value": {
                      "items": [
                        {
                          "companyId": "A00123",
                          "status": "Approved"
                        },
                        {
                          "companyId": "A00124",
                          "status": "Approved"
                        }
                      ],
                      "totalCount": 2
                    }
                  },
                  "Empty Result": {
                    "value": {
                      "items": [],
                      "totalCount": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Returns the details of the error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericErrorResponse"
                },
                "examples": {
                  "Invalid CompanyId Format": {
                    "value": {
                      "correlationId": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3g4h5i6",
                      "values": [
                        {
                          "code": "BadRequest",
                          "message": "Invalid companyId format. CompanyId must be alphanumeric with maximum 9 characters."
                        }
                      ]
                    }
                  },
                  "Invalid Status Value": {
                    "value": {
                      "correlationId": "b2c3d4e5-f6g7-48h9-i0j1-k2l3m4n5o6p7",
                      "values": [
                        {
                          "code": "BadRequest",
                          "message": "OnboardingStatus must be one of: InProgress, Approved, Rejected, Suspended"
                        }
                      ]
                    }
                  },
                  "Missing Required Field": {
                    "value": {
                      "correlationId": "c3d4e5f6-g7h8-49i0-j1k2-l3m4n5o6p7q8",
                      "values": [
                        {
                          "code": "BadRequest",
                          "message": "The CompanyId field is required."
                        }
                      ]
                    }
                  },
                  "Invalid Filter Expression": {
                    "value": {
                      "correlationId": "d4e5f6g7-h8i9-40j0-k1l2-m3n4o5p6q7r8",
                      "values": [
                        {
                          "code": "BadRequest",
                          "message": "Invalid filter expression. Expected format: 'field eq value' or 'field ct value'"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ClientOnboardingDto": {
        "type": "object",
        "properties": {
          "companyId": {
            "type": "string",
            "nullable": true,
            "x-pcty-filterable": true,
            "x-pcty-filter-operators": "eq,ne,ct,sw,in"
          },
          "status": {
            "enum": [
              "InProgress",
              "Approved",
              "Rejected",
              "Suspended"
            ],
            "type": "string",
            "x-pcty-filterable": true,
            "x-pcty-filter-operators": "eq,ne,ct,sw,in"
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        }
      },
      "ClientOnboardingDtoDtoPage": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientOnboardingDto"
            },
            "nullable": true
          },
          "totalCount": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        }
      },
      "ErrorDto": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          },
          "fields": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        }
      },
      "GenericErrorResponse": {
        "type": "object",
        "properties": {
          "correlationId": {
            "type": "string",
            "nullable": true
          },
          "values": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        }
      }
    }
  }
}
```