Table of Contents
Paycom offers online payroll services and HR software solutions for both big and small businesses to manage the entire employment life cycle, from recruitment to retirement.
API Overview
Paycom is a comprehensive human capital management (HCM) solution that streamlines HR processes for businesses of all sizes. It offers a suite of integrated modules covering payroll, time and attendance, benefits administration, employee self-service, and talent management. Paycom's intuitive interface, mobile accessibility, and robust reporting capabilities empower HR teams to manage their workforce efficiently and effectively. The platform provides real-time data and analytics, enabling businesses to make informed decisions and optimize their HR strategies. Paycom's commitment to innovation and customer satisfaction has made it a trusted partner for organizations seeking to enhance their HR operations.
Paycom's API overview provides developers with the tools and resources to integrate Paycom's functionality into their own applications. The comprehensive documentation includes detailed API reference guides, code samples, and tutorials. Paycom's REST APIs offer a flexible and scalable way to access Paycom's data and services. Webhooks allow developers to receive real-time notifications when specific events occur within Paycom, enabling them to build automated workflows and integrations. To ensure the integrity and performance of the API, Paycom implements rate limits to prevent excessive usage. By leveraging Paycom's API, developers can extend the capabilities of Paycom's HCM solution and tailor it to the unique needs of their organizations.
API Request Limits
Free Plan
100 requests per minute
Starter Plan
500 requests per minute
Professional Plan
1,000 requests per minute
Enterprise Plan
2,000 requests per minute
SDKs
APIs
Method: GET
Description: Get details of an employee..
Endpoint: /v1/employees/{employeeId}
Parameters: employeeId
Method: GET
Description: Get a list of employees..
Endpoint: /v1/employees
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a time entry..
Endpoint: /v1/time-entries/{timeEntryId}
Parameters: timeEntryId
Method: GET
Description: Get a list of time entries.
Endpoint: .
Parameters: /v1/time-entries
Method: GET
Description: Get details of an absence..
Endpoint: /v1/absences/{absenceId}
Parameters: absenceId
Method: GET
Description: Get a list of absences..
Endpoint: /v1/absences
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a paycheck..
Endpoint: /v1/paychecks/{paycheckId}
Parameters: paycheckId
Method: GET
Description: Get a list of paychecks..
Endpoint: /v1/paychecks
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a company..
Endpoint: /v1/companies/{companyId}
Parameters: companyId
Method: GET
Description: Get a list of companies..
Endpoint: /v1/companies
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of compensation..
Endpoint: /v1/compensations/{compensationId}
Parameters: compensationId
Method: GET
Description: Get a list of compensation..
Endpoint: /v1/compensations
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a job..
Endpoint: /v1/jobs/{jobId}
Parameters: jobId
Method: GET
Description: Get a list of jobs..
Endpoint: /v1/jobs
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a location..
Endpoint: /v1/locations/{locationId}
Parameters: locationId
Method: GET
Description: Get a list of locations..
Endpoint: /v1/locations
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a department..
Endpoint: /v1/departments/{departmentId}
Parameters: departmentId
Method: GET
Description: Get a list of departments..
Endpoint: /v1/departments
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a division..
Endpoint: /v1/divisions/{divisionId}
Parameters: divisionId
Method: GET
Description: Get a list of divisions..
Endpoint: /v1/divisions
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a custom field..
Endpoint: /v1/custom-fields/{customFieldId}
Parameters: customFieldId
Method: GET
Description: Get a list of custom fields..
Endpoint: /v1/custom-fields
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a custom value..
Endpoint: /v1/custom-values/{customValueId}
Parameters: customValueId
Method: GET
Description: Get a list of custom values..
Endpoint: /v1/custom-values
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a pay rule..
Endpoint: /v1/pay-rules/{payRuleId}
Parameters: payRuleId
Method: GET
Description: Get a list of pay rules..
Endpoint: /v1/pay-rules
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a pay group..
Endpoint: /v1/pay-groups/{payGroupId}
Parameters: payGroupId
Method: GET
Description: Get a list of pay groups..
Endpoint: /v1/pay-groups
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a tax year..
Endpoint: /v1/tax-years/{taxYearId}
Parameters: taxYearId
Method: GET
Description: Get a list of tax years..
Endpoint: /v1/tax-years
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a tax withholding..
Endpoint: /v1/tax-withholdings/{taxWithholdingId}
Parameters: taxWithholdingId
Method: GET
Description: Get a list of tax withholdings..
Endpoint: /v1/tax-withholdings
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a tax..
Endpoint: /v1/taxes/{taxId}
Parameters: taxId
Method: GET
Description: Get a list of taxes..
Endpoint: /v1/taxes
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a benefit..
Endpoint: /v1/benefits/{benefitId}
Parameters: benefitId
Method: GET
Description: Get a list of benefits..
Endpoint: /v1/benefits
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a deduction..
Endpoint: /v1/deductions/{deductionId}
Parameters: deductionId
Method: GET
Description: Get a list of deductions..
Endpoint: /v1/deductions
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a notice..
Endpoint: /v1/notices/{noticeId}
Parameters: noticeId
Method: GET
Description: Get a list of notices..
Endpoint: /v1/notices
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of a job requisition..
Endpoint: /v1/job-requisitions/{jobRequisitionId}
Parameters: jobRequisitionId
Method: GET
Description: Get a list of job requisitions..
Endpoint: /v1/job-requisitions
Parameters: count, fields, filter, offset, order, search, summarize
Method: GET
Description: Get details of an employment screening..
Endpoint: /v1/employment-screenings/{employmentScreeningId}
Parameters: employmentScreeningId
Method: GET
Description: Get a list of employment screenings..
Endpoint: /v1/employment-screenings
Parameters: count, fields, filter, offset, order, search, summarize
FAQ
How do I get an API key?
To obtain an API key, you must first create a developer account on the Paycom website. Once you have created an account, you can request an API key by completing the form on the 'API Keys' page.
What is the rate limit for API requests?
The rate limit for API requests is 100 requests per minute per API key. If you exceed this limit, your requests will be throttled.
How do I authenticate to the API?
You can authenticate to the API using either Basic Authentication or OAuth 2.0. For Basic Authentication, you will need to provide your API key in the 'Authorization' header of your requests. For OAuth 2.0, you will need to obtain an access token from the Paycom API and include it in the 'Authorization' header of your requests.
Can I use the sandbox environment to test my API integrations?
Yes, you can use the sandbox environment to test your API integrations. The sandbox environment is a separate environment from the production environment, and it contains test data that you can use to test your integrations without affecting live data.
What is the difference between a developer account and a production account?
A developer account is used for testing and development purposes, while a production account is used for live data and transactions. Developer accounts have access to the sandbox environment, while production accounts have access to the production environment.