Job Codes

Get Job Codes [Batch]

Summary Description

The GET Job Code List by Company ID endpoint, retrieves a comprehensive list of Job Codes from the Paylocity system with each call. Pagination can be achieved by using the "jobs" parameter and specifying the values of "limit" and "offset" to decide the quantity of records to be retrieved. The utilization of the "limit" option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the "offset" option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned

Use Cases

  • The GET a list of Job Codes API endpoint allows users to fetch specific Job Code details from a client's Paylocity instance. To use this endpoint, the Paylocity Company ID must be specified
  • The 'Get Job Codes List by Company ID' endpoint empowers API users to fetch a comprehensive list of Job Codes alongside their relevant data
get/apiHub/payroll/v1/companies/{companyId}/jobs

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
  • 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.

Query parameters

filterstring

The API Filter, by defining specific conditions, enables developers to fine-tune data from API calls for more precise results, enhancing application efficiency and user-friendliness. For more information review the Filtering page.

limitinteger

Number of jobs per page. Default Value: 20 Maximum Value: 100

offsetinteger

Pagination offset.

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.