---
title: "Get Company-Specific Open API Documentation"
method: GET
path: "/v2/companies/{companyId}/openapi"
tags: ["Company-Specific Schema"]
---

# Get Company-Specific Open API Documentation

`GET /v2/companies/{companyId}/openapi`

The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas. These customized resource schemas define certain properties as enumerations of pre-defined values that correspond to the company's setup with Paylocity Payroll/HR solution. The customized schemas also indicate which properties are required by the company within Paylocity Payroll/HR solution.<br  />To learn more about Open API, click [here](https://www.openapis.org/)

## Path parameters

- `companyId` string, required

## Headers

- `Authorization` string, required

## Response `200`

Successfully retrieved

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error

---

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