Job Codes

Get Job Code [Single]

Summary Description

The GET Single Job Code API endpoint allows users to fetch specific Job Code details from a client's Paylocity instance. To use this endpoint, the Paylocity Company ID and Job Code must be specified

Use Cases

  • This API endpoint will allow an API user to retrieve a Job Code record for a specific company ID and Job Code ID
get/apiHub/payroll/v1/companies/{companyId}/jobs/{jobCode}

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/jobs/{jobCode}
  • Auth
    none declared

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

jobCodestring required

A specific identifier or label assigned to individual tasks, projects, or assignments within a company. Allowable Values: A Job Code may contain up to 20 alpha-numeric characters. Spaces or special characters are not allowed

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring

Authorization token. Ex. Bearer ...

Response

OK

companyIdstring nullable

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity

codestring nullable

A Job Code may contain up to 20 alpha-numeric characters. Spaces or special characters are not allowed

descriptionstring nullable

The Job Code description may contain up to 40 alpha-numeric characters. Spaces or special characters are not allowed

isActiveboolean nullable

Active (Yes/No). The job code is currently active or inactive

isCertifiedboolean nullable

Certified Job (Yes/No). This is a certified job code as per the CMS PBJ Report (Centers for Medicare and Medicaid Services Payroll Based Journal) job costing report by industry

Changes

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