Skip to navigation

Get Company Information

View as Markdown

Summary Description

The Get Company Information API endpoint provides access to specific company details. Users can retrieve a wide range of company information, including: company name, address, industry, (EIN) Employer Identification Number, and more.

Use Cases

  • Once the developer has company information, they can update their system with the latest earning codes. To update the earning codes in their system and they need to know what earning codes are available in Paylocity.
  • After getting company data, clients are use the company specific schema to pull the information into their UI to expose to a user.
  • Once the developer has company information, developers can add a New Employee to Paylocity and the system requires them to include the Benefit Class assigned in Paylocity for the New Employee.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

Headers

testModestringOptional
If true all responses are mocked and generated randomly.
AcceptstringOptional

Media type(s) the client can accept in the response (typically application/json).

Response

Successful response

Errors

401
Unauthorized Error