Jump to Content

Guides Recipes API Reference Changelog

API Reference

Guides Recipes API Reference Changelog

API Basics

Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
Postman Collection

Assessments API

Assessments Overview
Callback
Order
- Update Assessment Orderpatch
Package
Subscription
- Upsert Subscriptionput
Client Onboarding

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Update Screening Order Statuspatch

Company Level Information

Company Information
- Get Company Informationget
Payroll/HR
Cost Centers
- Get Cost Center Codesget
- Upsert Cost Center Codeput
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Get Employees [Batch]get
- Get Employee [Single]get

Learning Management API

LMS API Overview
Training Content

Partner Onboarding API

Onboarding Overview
Client Onboarding
- Get Onboarding Statusget
- Upsert Onboarding Statusput

Pay Entry

Pay Entry
- Get New Payroll Batch Statusget
- Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Recurring Deductions
Recurring Earnings

Punch Import API

Punch Import Overview
Punch Import Data Fields
Punch Import
- Create Employee Punch [Batch]post

Punch detail Api

Punch Details Overview
Company Punch Details
- Create Company Punch Detail Operationpost
Employee Punch Details
- Gets Employee Punch Detailsget
- [DEPRECATED] Gets Employee Punch Detailsget

Scheduling Api

Employee Shifts
- Returns employee shiftsget
Company Shifts
- Returns a list of shifts for a companyget
Open Shifts
- Returns a list of openShiftsget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

Get All Custom Fields

get https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/customfields/{category}

Get All Custom Fields for the selected company

Language

Credentials

OAuth2

Bearer

Copyright © 2025 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility