Paylocity API

Name: Paylocity API
Brand: Paylocity API
Availability: InStock

✓ Official Vendor SpecHR recruitingPayrolloauth232 EndpointsREST

For Agents

Manage employee records, retrieve pay statements, configure earnings and tax withholding, and set up direct deposits for companies using Paylocity payroll.

Install Jentic One Beta

Connect the Paylocity API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Paylocity API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Paylocity API.

Retrieve detailed pay statements with earnings, deductions, and tax breakdowns by year or check date

Manage employee earnings configurations including recurring and one-time earning codes

Configure federal, state, and local tax withholding elections for employees

GET STARTED

Start building with Paylocity API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Paylocity API for, with concrete tasks.

★ Pay Statement Reporting

Retrieve detailed pay statement data for employees including summaries and line-by-line details by year or specific check date. The API returns gross pay, net pay, all earning codes, deductions, and tax withholdings. This powers internal dashboards, employee self-service portals, and annual compensation reporting without manual data exports from the Paylocity UI.

Retrieve the pay statement summary for employee {employeeId} in company {companyId} for the year 2026 via GET /v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/2026

Employee Onboarding and Data Management

Create new employee records with complete demographic, compensation, tax, and direct deposit information through the API. The WebLink staging endpoint supports bulk imports for organizations hiring at scale. Existing employee records can be updated with PATCH requests covering name changes, address updates, or role transitions.

Create a new employee in company {companyId} via POST /v2/companies/{companyId}/employees with name, hire date, annual salary of $65,000, and federal tax filing status of single

Tax and Compensation Configuration

Manage all aspects of employee tax withholding including federal, primary state, non-primary state, and local tax codes. The API supports adding new local tax jurisdictions, updating withholding elections, and removing obsolete tax records. Combined with earnings management endpoints, this enables complete compensation lifecycle handling from hire through termination.

Add a new local tax code for employee {employeeId} in company {companyId} via POST /v2/companies/{companyId}/employees/{employeeId}/localTaxes with the jurisdiction code and withholding percentage

AI Agent Payroll Integration via Jentic

AI agents connect to the Paylocity API through Jentic to retrieve pay data, manage employee records, and configure compensation without implementing OAuth 2.0 client credentials or handling token lifecycle management. Jentic provides intent-based search so agents find operations like 'get pay statement' and receive the complete endpoint schema ready for execution.

Search Jentic for 'retrieve employee pay statement', load the operation schema, and execute it for employee {employeeId} in company {companyId} for the current year

Key Endpoints

32 endpoints — the paylocity api provides programmatic access to employee payroll and human capital management data for us employers.

METHOD

PATH

DESCRIPTION

POST

/v2/companies/{companyId}/employees

Create a new employee record

GET

/v2/companies/{companyId}/employees/{employeeId}

Retrieve employee details

GET

/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}

Get detailed pay statements for a year

GET

/v2/companies/{companyId}/employees/{employeeId}/earnings

List employee earnings

GET

/v2/companies/{companyId}/employees/{employeeId}/directDeposit

Get direct deposit configuration

PUT

/v2/companies/{companyId}/employees/{employeeId}/primaryStateTax

Update primary state tax

POST

/v2/companies/{companyId}/employees/{employeeId}/localTaxes

Add local tax configuration

POST

/v2/weblinkstaging/companies/{companyId}/employees/newemployees

Bulk stage new employees via WebLink

POST

/v2/companies/{companyId}/employees

Create a new employee record

GET

/v2/companies/{companyId}/employees/{employeeId}

Retrieve employee details

GET

/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}

Get detailed pay statements for a year

GET

/v2/companies/{companyId}/employees/{employeeId}/earnings

List employee earnings

GET

/v2/companies/{companyId}/employees/{employeeId}/directDeposit

Get direct deposit configuration

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Paylocity OAuth 2.0 client credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped bearer tokens — the client secret never enters the agent's context window.

Intent-based discovery

Agents search by intent (e.g., 'get employee pay statement') and Jentic returns the matching Paylocity operation with path parameters and query options, so the agent can target the right endpoint without browsing 32 endpoints.

Time to first call

Direct Paylocity integration: 3-5 days for OAuth setup, endpoint mapping, and error handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Paylocity API through Jentic.

What authentication does the Paylocity API use?

The Paylocity API uses OAuth 2.0 client credentials flow. You obtain a token by posting your client ID and secret to api.paylocity.com/IdentityServer/connect/token with the WebLinkAPI scope. Through Jentic, OAuth credentials are stored in the MAXsystem vault and agents receive scoped tokens automatically.

Can I retrieve detailed pay statements with the Paylocity API?

Yes. The GET /v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year} endpoint returns line-item detail including each earning code, deduction, and tax withholding for every check in that year. You can also filter by specific check date using the /{checkDate} path suffix.

What are the rate limits for the Paylocity API?

Paylocity enforces rate limits per OAuth client. Standard integrations are limited to approximately 5 requests per second with daily quotas based on your subscription. The API returns 429 Too Many Requests when limits are exceeded. Jentic handles rate limiting and retry logic when executing operations.

How do I add a new employee through the Paylocity API via Jentic?

Search Jentic for 'create a new employee in payroll' to find the POST /v2/companies/{companyId}/employees operation. Jentic returns the full input schema including required fields like firstName, lastName, companyId, and employeeStatus. Execute through Jentic and it handles OAuth token acquisition. Install with pip install jentic.

Can I manage tax withholding configurations via the API?

Yes. The API provides PUT /v2/companies/{companyId}/employees/{employeeId}/primaryStateTax for state tax, PUT /v2/companies/{companyId}/employees/{employeeId}/nonprimaryStateTax for secondary states, and POST and DELETE operations on /v2/companies/{companyId}/employees/{employeeId}/localTaxes for local jurisdictions.

Does the Paylocity API support bulk employee imports?

Yes. The POST /v2/weblinkstaging/companies/{companyId}/employees/newemployees endpoint stages multiple new employee records through the WebLink system. This is designed for bulk onboarding scenarios where organizations need to add many employees simultaneously during seasonal hiring or acquisitions.

Paylocity API

Connect the Paylocity API to your agent

Capabilities

Start building with Paylocity API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs