PApaylocity
Company-Specific Schema

Get Company-Specific Open API Documentation

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

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

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

Headers

Authorizationstring required

Bearer + JWT

Response

Successfully retrieved

Changes

No recorded changes to this operation across all 1 revision of this API.