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 Web Pay. The customized schemas also indicate which properties are required by the company within Web Pay.<br />To learn more about Open API, click here

get/v2/companies/{companyId}/openapi

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.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

Company Id

Headers

Authorizationstring required

Bearer + JWT

Response

Successfully retrieved

Changes

No recorded changes to this operation across all 4 revisions of this API.