Get Company-Specific Open API Documentation

get https://dc1demogw.paylocity.com/api/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.
To learn more about Open API, click here

Responses

200

Successfully retrieved

403

Forbidden

429

Too Many Requests

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dc1demogw.paylocity.com/api/v2/companies/companyId/openapi \
3
     --header 'accept: application/json'

Choose an example:

application/json

400Bad Request

500Internal Server Error