Paychex API Directory

Paychex is a payroll and HR solutions provider designed to simplify workforce management for businesses of all sizes. It offers a range of tools for payroll processing, employee benefits, time tracking, and compliance, helping companies streamline their HR tasks.

‍

With Paychex’s API, developers can integrate payroll, benefits, and other HR data with external applications, enabling automation and giving teams a single, consistent view of employee-related tasks across platforms.

‍

Here are some key highlights of the Paychex APIs:

1. Payroll Processing: Automate payroll calculations, deductions, and tax filings for smooth and timely payments.
2. Employee Management: Access and manage employee data, including personal details, employment status, and role-based permissions.
3. Time and Attendance: Track employee hours, manage time-off requests, and streamline attendance records for accurate payroll processing.
4. Benefits Administration: Integrate employee benefits data to easily manage enrollments, coverage updates, and compliance reporting.
5. Compliance and Tax Data: Access tax compliance data and generate reports to simplify filing and stay aligned with local, state, and federal regulations.
6. Secure Authentication: Uses OAuth 2.0 for secure data exchange, ensuring that sensitive payroll and employee information is protected.

In this article, we will explore what are the most commonly used Paychex API endpoints and how they allow businesses to streamline their HR and payroll operations, making it easy to integrate Paychex services into existing workflows.

‍

Paychex API Endpoints

Here are the most commonly used Paychex API endpoints -

‍

Authentication

• POST https://api.paychex.com/auth/oauth/v2/token

Company

• GET https://api.paychex.com/companies
• GET https://api.paychex.com/companies/{companyId}
• GET https://api.paychex.com/companies/{companyId}/calculationbases
• GET https://api.paychex.com/companies/{companyId}/contacttypes
• GET https://api.paychex.com/companies/{companyId}/customfields
• POST https://api.paychex.com/companies/{companyId}/customfields
• GET https://api.paychex.com/companies/{companyId}/customfields/{customFieldId}
• DELETE https://api.paychex.com/companies/{companyId}/customfields/{customfieldid}
• PATCH https://api.paychex.com/companies/{companyId}/customfields/{customfieldid}
• GET https://api.paychex.com/companies/{companyId}/customfieldscategories
• POST https://api.paychex.com/companies/{companyId}/customfieldscategories
• GET https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryId}
• DELETE https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryid}
• PATCH https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryid}
• GET https://api.paychex.com/companies/{companyId}/jobs
• POST https://api.paychex.com/companies/{companyId}/jobs
• GET https://api.paychex.com/companies/{companyId}/jobs/{jobId}
• PATCH https://api.paychex.com/companies/{companyId}/jobs/{jobId}
• GET https://api.paychex.com/companies/{companyId}/jobsegments
• GET https://api.paychex.com/companies/{companyId}/jobtitles
• GET https://api.paychex.com/companies/{companyId}/jobtitles/{jobTitleId}
• GET https://api.paychex.com/companies/{companyId}/laborassignments
• GET https://api.paychex.com/companies/{companyId}/laborassignments/{laborAssignmentId}
• GET https://api.paychex.com/companies/{companyId}/locations
• GET https://api.paychex.com/companies/{companyId}/locations/{locationId}
• GET https://api.paychex.com/companies/{companyId}/organizations
• GET https://api.paychex.com/companies/{companyId}/organizations/{orgId}
• GET https://api.paychex.com/companies/{companyId}/payfrequencies
• GET https://api.paychex.com/companies/{companyId}/workers
• POST https://api.paychex.com/companies/{companyId}/workers
• GET https://api.paychex.com/companies/{companyId}/workerstatuses
• GET https://api.paychex.com/companies/{companyId}/workerstatuses/{statusId}

‍

Payroll

• GET https://api.paychex.com/companies/{companyId}/checks
• POST https://api.paychex.com/companies/{companyId}/checks
• GET https://api.paychex.com/companies/{companyId}/paycomponents
• GET https://api.paychex.com/companies/{companyId}/paycomponents/{paycomponentId}
• GET https://api.paychex.com/companies/{companyId}/payperiods
• GET https://api.paychex.com/companies/{companyId}/payperiods/{payperiodId}
• GET https://api.paychex.com/workers/{workerId}/checks
• POST https://api.paychex.com/workers/{workerId}/checks
• GET https://api.paychex.com/workers/{workerId}/checks/{externalCheckId}
• DELETE https://api.paychex.com/workers/{workerId}/checks/{externalCheckId}
• DELETE https://api.paychex.com/checks
• POST https://api.paychex.com/checks/{checkId}/checkcomponents
• DELETE https://api.paychex.com/checks/{checkId}/checkcomponents/{checkComponentId}
• PATCH https://api.paychex.com/checks/{checkId}/checkcomponents/{checkComponentId}

‍

Worker

• GET https://api.paychex.com/workers/{workerId}
• DELETE https://api.paychex.com/workers/{workerId}
• PATCH https://api.paychex.com/workers/{workerId}
• GET https://api.paychex.com/workers/{workerId}/assignmentdistributions
• GET https://api.paychex.com/workers/{workerId}/communications
• POST https://api.paychex.com/workers/{workerId}/communications
• GET https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• DELETE https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• PATCH https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• GET https://api.paychex.com/workers/{workerId}/compensation
• GET https://api.paychex.com/workers/{workerId}/compensation/payrates
• POST https://api.paychex.com/workers/{workerId}/compensation/payrates
• GET https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• DELETE https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• PATCH https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• GET https://api.paychex.com/workers/{workerId}/compensation/paystandards
• GET https://api.paychex.com/workers/{workerId}/contacts
• POST https://api.paychex.com/workers/{workerId}/contacts
• GET https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• DELETE https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• PATCH https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• GET https://api.paychex.com/workers/{workerId}/customfields
• POST https://api.paychex.com/workers/{workerId}/customfields
• GET https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• DELETE https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• PATCH https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• GET https://api.paychex.com/workers/{workerId}/directdeposits
• POST https://api.paychex.com/workers/{workerId}/directdeposits
• PATCH https://api.paychex.com/workers/{workerId}/directdeposits
• GET https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• DELETE https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• PATCH https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• GET https://api.paychex.com/workers/{workerId}/federaltax
• POST https://api.paychex.com/workers/{workerId}/federaltax
• DELETE https://api.paychex.com/workers/{workerId}/federaltax
• PATCH https://api.paychex.com/workers/{workerId}/federaltax
• GET https://api.paychex.com/workers/{workerId}/federaltax
• POST https://api.paychex.com/workers/{workerId}/paycomponents
• PATCH https://api.paychex.com/workers/{workerId}/paycomponents
• GET https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• DELETE https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• PATCH https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• GET https://api.paychex.com/workers/{workerId}/status
• GET https://api.paychex.com/workers/{workerId}/timeoff

‍

Management

• POST https://api.paychex.com/management/requestclientaccess

‍

Webhooks

• GET https://api.paychex.com/management/domains
• GET https://api.paychex.com/management/hooks
• POST https://api.paychex.com/management/hooks
• GET https://api.paychex.com/management/hooks/{hookId}
• DELETE https://api.paychex.com/management/hooks/{hookId}

‍

Here’s a detailed reference to all the Paychex API Endpoints.

Paychex API FAQs

Here are the frequently asked questions about Paychex APIs to help you get started:

‍

Do Paychex APIs support pagination?

Yes. Knit works with paginated payroll APIs like Paychex every day, so its unified API handles the paging logic for you instead of leaving it to your team. On the Paychex side, list endpoints accept offset and limit query parameters (for example ?offset=5&limit=5), and Paychex recommends paging at 100 items per page for companies with a large worker count to avoid long runtimes and timeouts. Responses include hypermedia next, previous, and self links plus a pagination object with the offset, limit, and total item count, so you can walk through results without guessing at page boundaries. See Paychex's own paging documentation for the full spec.

What is the rate limit on Paychex API endpoints?

Paychex does not publish a fixed numeric rate limit (no fixed requests-per-second or per-minute figure), which is exactly the kind of ambiguity Knit is built to absorb for you: its integration layer backs off and retries automatically so a spike in one workflow doesn't take down another. Paychex instead states that it monitors for excessive calls and will reach out directly if an integration approaches its internal limit, so the practical guidance is to keep call volume reasonable and avoid unnecessary polling. Details are in Paychex's rate-limiting documentation.

What happens when I POST new workers via the Paychex API, and what are the required fields?

Creating a worker only requires three fields: given name, family name, and worker type (EMPLOYEE for W-2 staff or INDEPENDENT_CONTRACTOR for 1099 workers), and Knit's employee-data models map cleanly onto that same minimal schema so you don't have to special-case Paychex in your own worker-creation flow. A new worker starts in an IN_PROGRESS status and only moves to ACTIVE once all required fields are complete; adding an email or mobile number at creation time also triggers an automatic onboarding invite in Paychex Flex. Full details are in Paychex's worker documentation.

How do I specify a vendor media type profile in Paychex API requests, and is it required for each call?

It's optional. Knit normalizes these vendor-specific response formats behind a single schema, which matters here because Paychex media type profiles (passed in the request's Accept header, for example application/vnd.paychex.association_companies.v1+json) change the shape of the response for a given endpoint. Every resource has a default profile, so calls succeed without specifying one; you only add a profile when you need a specific response version or structure. See Paychex's vendor media type documentation for the available profiles.

What are the predefined headers used in Paychex API requests and responses?

Requests carry an Authorization header with a bearer access token and an optional X-payx-client-correlationId that Paychex recommends generating per request for troubleshooting; Knit passes these through automatically so individual API calls made through its unified layer stay traceable back to Paychex support tickets when something needs debugging. Responses come back with Content-Type (the vendor media type), caching headers (Cache-Control, Expires), a server-generated X-payx-txid for tracking, and an ETag on paginated resources. Full reference in Paychex's headers documentation.

Find more FAQs here.

‍

Get started with Paychex API

To access Paychex APIs, create a Paychex account and log in to the Developer Portal. Apply for API access, and upon approval, you'll receive your API credentials (client ID and secret). Use these for OAuth 2.0 authentication to securely access the API endpoints. Review the documentation for integration guidelines.

‍

If you’re looking for a quick way to connect multiple Payroll systems, consider using Knit, a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.