---
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`

## Request

- Base URL: `https://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/openapi`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

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.dev/paylocity/apis/weblink-api.md) - [All operations](https://skmtc.dev/paylocity/apis/weblink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/weblink-api/revisions/8152ed40b412?raw)