# Paylocity Developer Portal Documentation ## Guides - [Common Integration Use Cases](https://developer.paylocity.com/integrations/docs/common-use-cases-partners.md) - [Getting Started](https://developer.paylocity.com/integrations/docs/getting-started.md): How to start building your integration using Paylocity APIs - [Using Postman](https://developer.paylocity.com/integrations/docs/postman.md): How to use Postman to make test calls to Sandbox - [Getting Support](https://developer.paylocity.com/integrations/docs/getting-support-pre-post-production.md) - [Integration Implementation Best Practices](https://developer.paylocity.com/integrations/docs/impl-best-practices.md): Leverage the Paylocity API to integrate Paylocity data with company systems. - [Data Element & Directionality Mapping](https://developer.paylocity.com/integrations/docs/data-element-directionality-mapping.md): Explaining the data flow of your integration. - [Integration Deliverables by Phase](https://developer.paylocity.com/integrations/docs/deliverables-by-phase.md): a reference table of deliverables by role/owner - [Integration Requirements](https://developer.paylocity.com/integrations/docs/integration-requirements.md): Integration evaluation & certification for Go-Live - [Integrations FAQ](https://developer.paylocity.com/integrations/docs/integrations-faq.md): Frequently asked questions related to building integrations using our APIs - [Technology Partner Requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements.md): Overview of the Paylocity Partner Evaluation & Certification Process - [Integration Platforms](https://developer.paylocity.com/integrations/docs/integration-platforms.md): Paylocity Approved Unified API Platforms & 3rd Party Integrators - [Partner Landing Page Requirements Overview](https://developer.paylocity.com/integrations/docs/landing-page-requirements-overview.md): Streamline our mutual client experience by creating a Landing Page. - [Company & Company Sets](https://developer.paylocity.com/integrations/docs/company-and-company-sets.md) - [Employee Status](https://developer.paylocity.com/integrations/docs/employee-status.md) - [Employee Transfers](https://developer.paylocity.com/integrations/docs/employee-transfers.md): This guide explains how employee transfers work in Paylocity and how they appear when consuming Paylocity APIs. It outlines how transferred employees are represented across multiple Company IDs, how to identify the active employee record, and best practices for handling transferred employees in third-party systems. - [Paylocity Key Concepts](https://developer.paylocity.com/integrations/docs/paylocity-key-concepts.md): Helping understand relationships of entities in the Paylocity solution to help map data between integration systems - [List & Lookup Values](https://developer.paylocity.com/integrations/docs/list-lookup-values.md) - [Pay Setup - Deductions & Earnings](https://developer.paylocity.com/integrations/docs/pay-setup-deductions-earnings.md) - [Punch Data Imports](https://developer.paylocity.com/integrations/docs/punch-data-imports.md) - [Synchronization & Webhooks](https://developer.paylocity.com/integrations/docs/synchronization-webhooks.md): Guidance on record synchronization across systems and leveraging webhooks ## API Reference - [Errors](https://developer.paylocity.com/integrations/reference/errors.md) - [Filtering](https://developer.paylocity.com/integrations/reference/filtering.md) - [Rate Limits](https://developer.paylocity.com/integrations/reference/rate-limits.md) - [API Versioning](https://developer.paylocity.com/integrations/reference/versioning.md) - [Employee Change Webhooks](https://developer.paylocity.com/integrations/reference/employee-change-webhooks.md) - [Future Dated Changes](https://developer.paylocity.com/integrations/reference/future-dated-change-webhooks.md) - [Webhooks](https://developer.paylocity.com/integrations/reference/webhooks-overview.md): Paylocity Webhooks enables system triggered notifications for application events. - [New Hire Webhooks](https://developer.paylocity.com/integrations/reference/new-hire-webhooks.md) - [Payroll Processed Webhooks](https://developer.paylocity.com/integrations/reference/payroll-processed-webhooks.md) - [Termination Webhooks](https://developer.paylocity.com/integrations/reference/termination-webhooks.md) - [Time Off Approval Webhooks](https://developer.paylocity.com/integrations/reference/time-off-approval-webhooks.md) - [Assessments Overview](https://developer.paylocity.com/integrations/reference/assessments-overview.md) - [Callback](https://developer.paylocity.com/integrations/reference/callback.md): Overview - [Filtering Orders](https://developer.paylocity.com/integrations/reference/filtering-orders.md): What operators are supported for filtering the GET orders endpoint on the Assessment API - [Get partner assessment orders](https://developer.paylocity.com/integrations/reference/get_apihub-performancemanagement-v1-companies-b6001-partner-assessmentorders.md): > 🚧 Partner Restricted > All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint allows partners retrieve assessment orders for companies actively onboarded to their API client ID. Orders can be filtered by company ID, order ID, candidate ID, or creation date, and are always sorted by companyId. **Use Case** A partner support team needs to troubleshoot a client issue. They use the endpoint to pull all assessment orders for a company and quickly identify discrepancies or status of the order in Paylocity. - [Order](https://developer.paylocity.com/integrations/reference/order.md) - [Get Assessment Packages](https://developer.paylocity.com/integrations/reference/get_apihub-performancemanagement-v1-companies-companyid-assessmentpackages.md): > 🚧 Partner Restricted > All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This API endpoint is used to retrieve assessment packages configured within Paylocity's platform for a specific companyId. **Use Cases** - Retrieve Packages: Fetch a list of all assessment packages available for a specific Paylocity client by using the companyId - Response Details: The API provides a count of packages and detailed information about each one, including IDs, status, summaries, names, and associated assessments and tests - [Package](https://developer.paylocity.com/integrations/reference/package.md): Overview - [Subscription](https://developer.paylocity.com/integrations/reference/subscription-1.md): Overview - [Background Check Overview](https://developer.paylocity.com/integrations/reference/background-check-overview.md) - [Delete Business Unit](https://developer.paylocity.com/integrations/reference/compliancebusinessunitdelete.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This is used to delete a businessUnit by companyId and specific businessUnitId for a given client **Use Cases** - Partner wants to delete a specific businessUnit for a client - [Get Business Unit](https://developer.paylocity.com/integrations/reference/compliancebusinessunitget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint returns a specific businessUnit for the companyId and businessUnitId **Use Cases** - Partner needs to confirm specific businessUnit details have been added into Paylocity for a given client - [Create Business Units](https://developer.paylocity.com/integrations/reference/compliancebusinessunitscreate.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint inserts businessUnits and their associated status by company ID for a given client **Use Cases** - Partner wants to send over one or multiple businessUnits for a client. This can either be when onboarding a new client, or when client wants to add new businessUnits to their company - Partner wants to make bulk changes to businessUnits to make them either active or inactive for a client - [Get Company Business Units](https://developer.paylocity.com/integrations/reference/compliancebusinessunitsget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint returns all businessUnits for the companyId querying **Use Cases** - Partner needs to confirm all businessUnits have been added into Paylocity for a client - Partner needs to confirm the status of businessUnits that have been added for a client - [Update Business Unit](https://developer.paylocity.com/integrations/reference/compliancebusinessunitupdate.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This is used to update an already registered businessUnit's details by companyId and specific businessUnitId for a given client **Use Cases** - Partner wants to update the details of a specific businessUnit for a client - [Business Unit](https://developer.paylocity.com/integrations/reference/business-unit.md) - [Update Screening Order Status](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckcandidatescreeningorderstatusupdate.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint updates the Screening Order status for the given companyId and candidateScreeningOrderId. The patch operation on the candidate status endpoint allows you to update the status of the overall screening order and the related services. You can also send the URL where the recruiter can view the complete screening result. Using this endpoint, partners will be able to add new services to orders that have already been placed. **Use Cases** - Partner sends the initial status of the order and services, i.e. Ordered and Pending - Partner needs to update the status of an order or services of an order - Partner is updating the order with new statuses and wants to add on additional services that were added to the order after it was placed - [Get Screening Orders for Partner](https://developer.paylocity.com/integrations/reference/compliancepartnerbackgroundcheckordersget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Partners can use this endpoint to retrieve background check (BGC) orders using flexible filters. It supports pulling orders across partner-linked companies, or narrowing by companyID, orderID, candidateID, or date range. Results are always sorted by companyID. **Use Case 1: Partner-wide Order Retrieval** A partner wants a consolidated feed of all BGC orders across every company tied to their API client ID for monitoring and reporting. **Use Case 2: Candidate-Specific Lookup** A partner needs to review all background check orders tied to a single candidate, filtered by their Paylocity candidateID. - [Filtering Orders](https://developer.paylocity.com/integrations/reference/filtering-orders-1.md): What operators are supported for filtering the GET orders endpoint on the Background Check API - [Candidate Screening Order](https://developer.paylocity.com/integrations/reference/candidate-screening-order.md) - [Create Billing Codes](https://developer.paylocity.com/integrations/reference/complianceclientonboardingbillingcreate.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint inserts the billing code and its status by companyId for a given client **Use Cases** - Partner wants to send over one or multiple billing codes for a client, can be when onboarding a new client, or can be when client adds new billing codes to their company - Partner wants to make bulk changes to billing codes to make them either active or inactive for a client - [Delete Billing Code](https://developer.paylocity.com/integrations/reference/complianceclientonboardingbillingdeletev2.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This is used to delete an already registered billing code, either active or inactive, by companyId and specific billing code for a given client **Use Cases** - Partner wants to permanently delete this billing code for a client V1 endpoint was deprecated to allow for special characters - [Update Billing Code Status](https://developer.paylocity.com/integrations/reference/complianceclientonboardingbillingupdatev2.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This is used to update an already registered billing code’s status by companyId and specific billing code for a given client **Use Cases** - Partner wants to update the status of a specific billing code for a client to either make active or inactive* V1 endpoint was deprecated to allow for special characters - [Get Company Billing Codes](https://developer.paylocity.com/integrations/reference/complianceclientonboardingpartnerbillingget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint returns billing codes for the companyId querying **Use Cases** - Partner needs to confirm all billing codes have been added into Paylocity for a client - Partner needs to confirm the status of billing codes that have been added for a client - [Get Client Onboardings](https://developer.paylocity.com/integrations/reference/complianceclientonboardingsget.md): > 🚧 Partner Restricted > > The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested in exploring partnership opportunities, please contact us at [Techpartnerships@paylocity.com](mailto:Techpartnerships@paylocity.com) **Summary Description** This endpoint allows partners to get their onboarded companies with an option of filtering by companyId and status. - [Upsert Onboarding Status](https://developer.paylocity.com/integrations/reference/complianceclientonboardingstatusupsert.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** This endpoint upserts the status of the integration with companyId specified in the body **Use Cases** - Partner receives a new client intake form and sends the ‘in progress’ status to Paylocity - Partner and client already have an existing relationship, partner sends the ‘approved’ status for client to have access to ordering in the recruiting UI - Client initiates a new client intake form. Client and partner decide not to move forward with the relationship. Partner sends the ‘rejected’ status - [Client Onboarding](https://developer.paylocity.com/integrations/reference/client-onboarding.md) - [Delete Screening Package](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckscreeningpackagedelete.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Deletes screening package **Use Cases** - Partner does not want this package to be displayed in the UI for the client - [Upsert Screening Packages [Batch]](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckscreeningpackagesbatchupsert.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Bulk Upsert information about screening packages **Use Cases** - Partner wants to send over multiple screening packages for a client, can be when onboarding a new client, or can be when client adds new packages to their company - Partner wants to make bulk changes to screening packages to make them either active or inactive for a client - Partner wants to update the prices of a client’s screening packages - Partner wants to bulk add services to a packages - Partner wants to add a billing code to correlate to a specific BGC package - [Get Screening Packages](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckscreeningpackagesget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Returns the screening packages for the companyId **Use Cases** - Partner needs to confirm that package information with Paylocity is correct and calls for the package information for a specific company ID - [Upsert Screening Package](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckscreeningpackageupsert.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Upserts information about screening packages for the companyId **Use Cases** - Partner wants to send over a screening package for a client, can be when onboarding a new client, or can be when client adds a new package to their company - Partner wants to make a specific screening package either active or inactive for a client - Partner wants to update the price of a client’s screening package - Partner wants to add services to a package - Partner wants to add a billing code to correlate to a specific BGC package - [Screening Package](https://developer.paylocity.com/integrations/reference/screening-package.md) - [Create Webhook for Candidate Screening Order](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckcandidatescreeningorderssubscriptioncreate.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Register the webhook URL for subscribing to new *CandidateScreeningOrder* events. Once registered, the partner’s webhook will receive real-time notifications whenever a new candidate order is placed. **Use Cases** - **Webhook Registration** Partner provides the webhook URL for new candidate orders - **Callback Response (below Responses section at bottom of page)** When an order is placed for a candidate within a Paylocity module, the partner’s webhook will receive a callback URL response containing the order payload. This payload includes the details of the order and can be used by the partner to initiate their own workflows. - **Example Use Case:** A client places a background check order for a candidate in the Recruiting module. The partner receives the order payload through their registered webhook URL and can process the request immediately. - [Delete Webhook for Candidate Screening Order](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckcandidatescreeningorderssubscriptiondelete.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Deletes the webhook - [Get Webhook for Candidate Screening Order](https://developer.paylocity.com/integrations/reference/compliancebackgroundcheckcandidatescreeningorderssubscriptionget.md): > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Returns the webhook for the subscription of a new candidate screening order - [Subscription](https://developer.paylocity.com/integrations/reference/subscription.md) - [Filtering Job Codes](https://developer.paylocity.com/integrations/reference/filtering-jobcodes.md): What operators are supported for filtering the Job Codes API - [Job Code API Overview](https://developer.paylocity.com/integrations/reference/job-code-api-overview.md) - [Get Cost Centers/Labor Levels](https://developer.paylocity.com/integrations/reference/get_apihub_time_v1_companies_companyid_costcenters.md): **Summary Description** The GET Time and Labor Cost Center List by Company ID endpoint retrieves a comprehensive list of cost centers from the Paylocity Time and Labor system with each call. A cost center is a specific department, division, or function within an organization that incurs costs but does not directly generate revenue. This API is essential for financial reporting, budgeting, and performance management. By accessing the costCenters endpoint, you can access an up-to-date and accurate list of these entities, providing granular insight into where an organization's expenses are originating. This data is critical for budget tracking, expense allocation, and operational efficiency analysis, helping businesses make informed financial decisions. **Use Cases** - Automated Financial Reporting: Integrate the API into business intelligence (BI) tools or financial dashboards to automatically generate reports on departmental spending, helping to identify and analyze cost trends over time without manual data entry. - Budget Management & Forecasting: Use the cost center data to create and manage budgets for different departments. By pulling the list of cost centers, a financial application can match them to expense data, enabling more accurate forecasting and budget variance analysis. - Payroll & Expense Allocation: Connect the API to a payroll system to correctly allocate employee hours and labor costs to the specific cost centers they worked for. This ensures accurate billing, job costing, and departmental expense tracking. - ERP & HCM Integration: Seamlessly integrate the Paylocity data with other Enterprise Resource Planning (ERP) or Human Capital Management (HCM) systems. This allows for a unified view of an organization's financial and personnel data, improving data consistency and streamlining operations. - Auditing & Compliance: Retrieve a list of all cost centers for internal and external audits. The API provides a single source of truth for cost center data, ensuring compliance with accounting standards and regulations by providing a clear trail of expenses. - [Documents Overview](https://developer.paylocity.com/integrations/reference/documents-overview.md) - [LMS API Overview](https://developer.paylocity.com/integrations/reference/lms-api-overview.md) - [Get Batch Upload Status](https://developer.paylocity.com/integrations/reference/get_apihub-learningmanagementsystem-v1-companies-companyid-content-bulk-bulkuploadid-status.md): > 🚧 Partner Restricted > All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our [partner requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) and [contact guidelines](https://developer.paylocity.com/integrations/docs/partnership-requirements#phase-1--discovery--agreement-terms). **Summary Description** Returns the status of a bulk upload operation, including overall progress, success/failure counts, and detailed status for each content item. Partners can call this endpoint at any time to monitor the progress of their bulk upload. **Use Cases** - Partner wants to check the progress of a bulk upload operation. - Partner needs to identify which content items succeeded or failed. - Partner wants detailed error messages for failed items. **Status Values** - `Pending`: Bulk upload request created, waiting for ZIP file upload - `Downloading`: ZIP file is being downloaded from File Access - `Downloaded`: ZIP file downloaded and extracted - `Processing`: Content items are being created in LMS - `Uploading`: Content files are being uploaded to LMS - `Created`: All content items created successfully (before upload) - `PartialCreated`: Some content items created, some failed (before upload) - `CreationFailed`: All content items failed to create - `Completed`: All content items successfully processed and uploaded - `PartialSuccess`: Some content items succeeded, some failed - `Failed`: All content items failed to process - [Get Training Content [Single]](https://developer.paylocity.com/integrations/reference/get_apihub-learningmanagementsystem-v1-companies-companyid-contents-contentid.md): > 🚧 Partner Restricted > All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our [partner requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) and [contact guidelines](https://developer.paylocity.com/integrations/docs/partnership-requirements#phase-1--discovery--agreement-terms). **Summary Description** The GET Training Content [Single] endpoint allows partners to retrieve details about specific content in a client media content library by content ID. By sending a GET request, users can access content metadata such as the content ID, title, description, URL, file ID, duration, and optional thumbnail URL. This API provides a way for partners to manage and review individual content items within their LMS integration. **Use Cases** - An integration retrieves a single content record to confirm that metadata values match the partner’s source system before updates or version changes. - A reporting or analytics tool retrieves data to analyze the statistics on the total number of employees assigned to the training. - A reporting or analytics tool retrieves data to analyze the statistics on the total number of employees who completed the training. - A content provider retrieves a single item to determine whether it should be updated, replaced, or deprecated based on its current metadata. - [Get Training Content [Batch]](https://developer.paylocity.com/integrations/reference/get_apihub-learningmanagementsystem-v1-companies-companyid-contents.md): > 🚧 Partner Restricted > All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our [partner requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) and [contact guidelines](https://developer.paylocity.com/integrations/docs/partnership-requirements#phase-1--discovery--agreement-terms). **Summary Description** The Training Content [Batch] endpoint allows partners to retrieve details about a client's media content library by company id. By sending a GET request, users can access content metadata such as the content ID, title, description, URL, file ID, duration, and optional thumbnail URL. This API provides a way for partners to manage and review individual content items within their LMS integration. **Use Cases** - A partner system retrieves batch content metadata to reconcile its internal content catalog with the client’s LMS library and identify missing, outdated, or duplicated items. - An integration retrieves content details to verify required metadata fields (such as title, URL, or duration) and confirm that content items meet organizational or regulatory requirements. - A content provider retrieves batch content data to identify items that require updates, version replacement, or removal based on file ID, duration, or metadata changes. - [Create Training Content [Batch]](https://developer.paylocity.com/integrations/reference/post_apihub-learningmanagementsystem-v1-companies-companyid-content-bulk.md): > 🚧 Partner Restricted > All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our [partner requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) and [contact guidelines](https://developer.paylocity.com/integrations/docs/partnership-requirements#phase-1--discovery--agreement-terms). **Summary Description** Creates a bulk upload request for multiple training content items. The partner provides metadata for all content items, and the API returns a single pre-signed upload URL where the partner can upload a ZIP file containing all content files. **Use Cases** - Partner wants to upload multiple training courses in a single operation. - Partner needs to efficiently add a library of content to their LMS catalog. **Validation Rules** - `contentItems` is required and must contain between 1 and 100 items - Each `contentItem` must follow the same validation rules as single content upload - `zipFileDetails` is required - `zipFileDetails.contentType` must be `application/zip` - `zipFileDetails.length` must be greater than 0 and less than 2 GB (2147483648 bytes) - `contentItems[].training` is optional; when provided, the `name` field is required and the `description` field is optional. Supplying the training object places the content in the **On-Demand Trainings** area of LMS. If the training object is omitted, the content is stored in the **Company Content Library**. - [Create Training Content [Single]](https://developer.paylocity.com/integrations/reference/post_apihub-learningmanagementsystem-v1-companies-companyid-content.md): > 🚧 Partner Restricted > All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our [partner requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) and [contact guidelines](https://developer.paylocity.com/integrations/docs/partnership-requirements#phase-1--discovery--agreement-terms). **Summary Description** The Create Training Content [Single] endpoint enables partners to add external media content to a client’s LMS library. This endpoint accepts a POST request to create new content in the customer's LMS library. It is the first step in the two-step process for adding content to the customer's LMS partner content library or on-demand library. The request includes required content metadata, such as title, description, content URL, and file details. Each content item is assigned a unique external content ID and may include an optional thumbnail URL. The resource schema defines the required and optional properties for content creation. - Option 1: Use the payload to add content directly to the customer library. - Option 2: Include the training object to add content directly to on-demand trainings. Ensure that fileDetails.length matches the actual file size. If not, file preview may fail. **Use Cases** - Partner needs to upload external content metadata (title, description, URL, file details). - Partner wants to add content directly to the customer library. - Partner wants to add content directly to on-demand trainings. - [Get Onboarding Status](https://developer.paylocity.com/integrations/reference/get_apihub-security-v1-companies-b6001-clientonboardings.md): > 🚧 Partner Restricted > > The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested in exploring partnership opportunities, please contact us at [Techpartnerships@paylocity.com](mailto:Techpartnerships@paylocity.com) **Summary Description** The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This endpoint allows partners to get their onboardings with an option of filtering by companyId and status. - [Client Onboarding](https://developer.paylocity.com/integrations/reference/client-onboarding-1.md) - [Onboarding Overview](https://developer.paylocity.com/integrations/reference/partner-onboarding.md): Used to onboard companies to a partner exclusive API - [Pay Details Overview](https://developer.paylocity.com/integrations/reference/pay-detail-api-overview.md) - [Get Pay Statement by ID](https://developer.paylocity.com/integrations/reference/get_apihub_payrollhistory_v1_companies_companyid_employees_employeeid_paystatements_paystatementid.md): > 🚧 Partner Restricted > This endpoint is restricted to organizations that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Retrieves the details of a single pay statement by its ID. - [Get Pay Statements by Employee and Date Range](https://developer.paylocity.com/integrations/reference/get_apihub_payrollhistory_v1_companies_companyid_employees_employeeid_paystatements.md): > 🚧 Partner Restricted > This endpoint is restricted to organizations that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities. **Summary Description** Retrieves all pay statements for the specified employee within the given date range. - [Get New Payroll Batch Status](https://developer.paylocity.com/integrations/reference/payentryv2_getpayentryimport.md): **Summary Description** The Get New Payroll Batch Status endpoint is used to retrieve the current status and details of a previously submitted payroll batch. **Key Features:** - Returns the processing status of the payroll batch (e.g., Pending, Completed, Error). - Provides timestamp information for when the batch was created. - Includes a summary of the data inserted into the batch. - Highlights any validation issues or errors that need resolution. **Important:** When a payroll batch is successfully submitted using the Create New Payroll Batch endpoint, a `202 Accepted` response is returned. This response includes a `timeImportFileTrackingId`, which is required to query the status of that specific batch. Use this `timeImportFileTrackingId` as the `{timeImportFileTrackingId}` path parameter in the GET New Payroll Batch Status endpoint. **Recommendation:** API users should call this endpoint after submitting a batch to ensure the data was successfully processed. If errors are present, they should be addressed before payroll is finalized. - [Create New Payroll Batch](https://developer.paylocity.com/integrations/reference/payentryv2_postpayentryimport.md): **Summary Description** The Pay Entry API allows API users to interface with Paylocity�s HR & Payroll module, specifically within the 'Run Payroll' feature. This API allows users to submit new payroll batches for a specified check date. The endpoint accepts summarized payroll data, allowing API users to import data from third-party systems. - [Pay Setup Overview](https://developer.paylocity.com/integrations/reference/pay-setup-overview.md): Employee Pay Setup - [Filtering Deductions](https://developer.paylocity.com/integrations/reference/filtering-deductions-1.md): What operators are supported for filtering the Deductions API - [Filtering Earnings](https://developer.paylocity.com/integrations/reference/filtering-earnings-1.md): What operators are supported for filtering the Earnings API - [Get Punch Detail Operation](https://developer.paylocity.com/integrations/reference/get_apihub_time_v2_companies_companyid_punchdetailoperations_operationid.md): **Summary Description** The Get Punch Detail Operation endpoint returns the status of an operation initiated in Step 1 of the punch details retrieval process. It indicates whether the operation is in progress, completed, or failed. This endpoint represents Step 2 in the process for retrieving punch details for all employees within a specified company ID. When the operation completes successfully, punch details can be retrieved in Step 3 using the resourceId from the final segment of the Location URL. For information about the complete sequence, see the Punch Detail Overview or the Getting Started with Company Punch Details API recipe. **Use Cases** - Determine whether the operation is in progress, completed, or failed. - Retrieve the resourceId after the successful completion of the operation by capturing the end of the location URL. - [Get Punch Detail Data](https://developer.paylocity.com/integrations/reference/get_apihub_time_v2_companies_companyid_punchdetails_resourceid.md): **Summary Description** The Get Punch Detail Data endpoint represents the final step in the process to retrieve punch details for all employees within a company. This endpoint retrieves punch detail results for all employees in a company using the resourceId generated in the previous step of the process. The endpoint returns completed results and supports filtering by relative start and end dates. Responses are paginated and require iteration through all pages to access the full data set. **Use Cases** - Retrieve all employee punch details for a company after the asynchronous process has finished. - Filter punch detail records by relative start and end dates to limit results to a specific time range. - Iterate through paginated responses using offset-based pagination to obtain the complete set of punch detail records. - [Create Company Punch Detail Operation](https://developer.paylocity.com/integrations/reference/post_apihub_time_v2_companies_companyid_punchdetails.md): **Summary Description** The Company Punch Detail endpoint returns punch records for all employees within a specified company. Company Punch Detail endpoint represents the first step in a three-step process for retrieving punch details at the company level. Results can be limited by specifying a start date and end date. Date and time filtering uses the consumer's time zone and supports standard daily boundaries (00:00:00, 12:00:00, and 23:59:59). For information about the complete sequence, see the Punch Detail Overview or the Getting Started with Company Punch Details API recipe. **Use Cases** - Retrieve punch details for all employees associated with a specific company ID. - Narrow results to a defined timeframe by using the relativeStart and relativeEnd parameters. - [Get Employee Punch Details](https://developer.paylocity.com/integrations/reference/get_apihub_time_v2_companies_companyid_employees_employeeid_punchdetails.md): **Summary Description** The GET Punch Detail V2 endpoint provides access to employee punch details effortlessly. The punch detail API will include all punch data for a single employee. It serves as a valuable tool for accessing, analyzing, and managing time-related records, providing intricate details related to employee punches. Punch Detail V2 offers four decimals of precision for timesheets using hours instead of seconds, allowing timesheets to display four decimal places and capturing hours with better precision. Punch times as well as non-work pay types will display up to four decimals. The Punch Details API can be filtered by the relative date and time based on your time zone. ``` Filtering by Date Range The Punch Detail API can be filtered by the relative date and time based on your time zone. For example: Start of the day: At 00:00:00 (midnight), marking the beginning of the day. Midday: At 12:00:00 (noon), halfway through the day. End of the day: At 23:59:59, just a second before the next day begins. ``` A 24 hour day is represented by using: relativeStart={{relativeStartTime}}&relativeEnd={{relativeEndTime}} "relativeStart": "2024-03-05T00:00:00" "relativeEnd": "2024-03-05T23:59:00" `/Time/v2/companies/{{companyId}}/employees/{{employeeId}}/punchdetails?relativeStart={{relativeStartTime}}&relativeEnd={{relativeEndTime}}` For more information on implementing this API, see our [Punch Details Overview](https://developer.paylocity.com/integrations/reference/punch-detail-overview) - [Punch Details Overview](https://developer.paylocity.com/integrations/reference/punch-detail-overview.md): Company and Employee Punch Details - [Punch Detail Best Practices](https://developer.paylocity.com/integrations/reference/punch-detail-best-practices.md) - [Punch Import Data Fields](https://developer.paylocity.com/integrations/reference/punch-import-field-mapping.md): Import Employee Time Punches into Paylocity Time & Labor - [Punch Import Overview](https://developer.paylocity.com/integrations/reference/punch-import-overview.md): Import Employee Time Punches into Paylocity Time & Labor - [Get Shifts by Company](https://developer.paylocity.com/integrations/reference/get_apihub_scheduling_v1_companies_companyid_shifts.md): **Summary Description** The GET Company Shifts endpoint returns information about the shifts at a company level. The response includes data such as start and end times, tasks associated with the shift, and any recorded overtime. **Use cases:** - Managers can review current shifts for the entire company and make adjustments based on staffing needs. - Users can view shift details such as start and end times, duration, cost centers, and pay type. - The endpoint allows retrieval of shift attributes such as timing, assigned tasks, and overtime. This information can be used to analyze work patterns and identify trends. - [Get Employee Shifts](https://developer.paylocity.com/integrations/reference/get_apihub_scheduling_v1_companies_companyid_employees_employeeid_shifts.md): **Summary Description** The GET Employee Shifts endpoint returns information about the shifts assigned to a specific employee. The response includes structured data such as shift start and end times, roles, required skills, and location details. **Use cases:** - Retrieve employee-assigned shifts, including timing, role information, and location. - Managers can access an employee's scheduled shifts to review staffing coverage and workload distribution. - When creating or adjusting schedules, managers can use this endpoint to identify potential conflicts with an employee's existing shifts, such as overlapping times. - [Get Open Shifts by Company](https://developer.paylocity.com/integrations/reference/get_apihub_scheduling_v1_companies_companyid_openshifts.md): **Summary Description** The GET Open Shifts endpoint returns all shifts that are not currently assigned to an employee. The response includes each open shift and the total number available, allowing supervisors and managers to determine how many shifts can be assigned. **Use cases:** - Managers can retrieve a list of unassigned shifts and make them available for employees to claim. - The endpoint can be used in a third-party system where employees view and request available shifts. Allocation can follow predefined rules such as seniority or skill requirements. - The endpoint provides skill requirements for each open shift, enabling organizations to match shifts with qualified employees. - [Upsert Additional Rates](https://developer.paylocity.com/integrations/reference/add-or-update-additional-rates.md): Sends new or updated employee additional rates information directly to Paylocity Payroll/HR solution. - [Create New Client Secret](https://developer.paylocity.com/integrations/reference/add-client-secret.md): Create new client secret for Paylocity-issued client id. See Weblink Authentication section for details. - [Get All Company Codes](https://developer.paylocity.com/integrations/reference/get-all-company-codes-and-descriptions-by-resource.md): Get All Company Codes for the selected company and resource. - [Get Company-Specific Open API Documentation](https://developer.paylocity.com/integrations/reference/get-company-specific-open-api-documentation.md): The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas. These customized resource schemas define certain properties as enumerations of pre-defined values that correspond to the company's setup with Paylocity Payroll/HR solution. The customized schemas also indicate which properties are required by the company within Paylocity Payroll/HR solution.
To learn more about Open API, click [here](https://www.openapis.org/) - [Get All Custom Fields](https://developer.paylocity.com/integrations/reference/get-all-custom-fields-by-category.md): > :construction: IMPORTANT! > If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS WEB LINK ENDPOINT. Instead, please follow the bulk upload process described in PEAK article [PCTY-148055](https://paylocity.egain.cloud/system/templates/selfservice/pcty/help/agent/locale/en-US/portal/308600000001000/content-version/PCTY-148055/PCTY-1388429/Upload-Custom-Fields-in-Bulk) **Summary Description** Get All Custom Fields for the selected company - [Upsert Deduction](https://developer.paylocity.com/integrations/reference/deduction-1.md): Upsert Deduction API sends new or updated employee deduction information directly to Paylocity Payroll/HR solution. - [Delete Deduction for Deduction Code / Start Date](https://developer.paylocity.com/integrations/reference/deletedeductionfordeductioncodestartdate.md): Delete Deduction API deletes an incorrect deduction from Paylocity Payroll/HR solution. - [Get All Deductions](https://developer.paylocity.com/integrations/reference/getalldeductions.md): Get All Deductions returns all deductions for the selected employee. - [Get Deduction for Deduction Code](https://developer.paylocity.com/integrations/reference/getdeductionfordeductioncode.md): Get Deduction for Deduction Code returns records for a specific deduction for the selected employee. - [Get All Direct Deposit](https://developer.paylocity.com/integrations/reference/get-all-direct-deposit.md): Get All Direct Deposit returns main direct deposit and all additional direct deposits for the selected employee. - [Upsert Earning](https://developer.paylocity.com/integrations/reference/add-or-update-an-employee-earning.md): Upsert Earning API sends new or updated employee earnings information directly to Paylocity Payroll/HR solution. - [Delete Earning by Earning Code and Start Date](https://developer.paylocity.com/integrations/reference/delete-earning-by-earning-code-and-start-date.md): Delete Earning by Earning Code and Start Date - [Get All Earnings](https://developer.paylocity.com/integrations/reference/get-all-earnings.md): Get All Earnings returns all earnings for the selected employee. - [Get Earning by Earning Code and Start Date](https://developer.paylocity.com/integrations/reference/get-earning-by-earning-code-and-start-date.md): Get Earnings returns the single earning with the provided earning code and start date for the selected employee. - [Get Earnings by Earning Code](https://developer.paylocity.com/integrations/reference/get-earnings-by-earning-code.md): Get Earnings returns all earnings with the provided earning code for the selected employee. - [Upsert Emergency Contacts](https://developer.paylocity.com/integrations/reference/add-or-update-emergency-contacts.md): Sends new or updated employee emergency contacts directly to Paylocity Payroll/HR solution. - [Upsert Employee's Benefit Setup](https://developer.paylocity.com/integrations/reference/update-or-add-employee-benefit-setup.md): Sends new or updated employee benefit setup information directly to Paylocity Payroll/HR solution. - [Create New Employee in Web Link](https://developer.paylocity.com/integrations/reference/add-new-employee-to-web-link.md): Create New Employee in Web Link will send partially completed or potentially erroneous new hire record to Web Link, where it can be corrected and completed by company administrator or authorized Paylocity Service Bureau employee. - [Create New Employee](https://developer.paylocity.com/integrations/reference/add-employee.md): Create New Employee API sends new employee data directly to Paylocity Payroll/HR solution. Companies who use the New Hire Template in Paylocity Payroll/HR solution may require additional fields when hiring employees. New Employee API Requests will honor these required fields. - [Get All Employees](https://developer.paylocity.com/integrations/reference/get-all-employees.md): Get All Employees API will return employee data currently available in Paylocity Payroll/HR solution. - [Get Employee](https://developer.paylocity.com/integrations/reference/get-employee.md): Get Employee API will return employee data currently available in Paylocity Payroll/HR solution. - [Update Employee](https://developer.paylocity.com/integrations/reference/update-employee.md): Update Employee API will update existing employee data in WebPay. - [Create New Local Tax](https://developer.paylocity.com/integrations/reference/add-local-tax.md): Sends new employee local tax information directly to Paylocity Payroll/HR solution. - [Delete Local Tax by Tax Code](https://developer.paylocity.com/integrations/reference/delete-local-tax-by-tax-code.md): Delete local tax by tax code - [Get All Local Taxes](https://developer.paylocity.com/integrations/reference/get-all-local-taxes.md): Returns all local taxes for the selected employee. - [Get Local Taxes by Tax Code](https://developer.paylocity.com/integrations/reference/get-local-tax-by-tax-code.md): Returns all local taxes with the provided tax code for the selected employee. - [Update Local Tax](https://developer.paylocity.com/integrations/reference/updatelocaltax.md): Update Local Tax sends updated local tax code information for the selected employee. - [Upsert Non-Primary State Tax](https://developer.paylocity.com/integrations/reference/add-or-update-non-primary-state-tax.md): Sends new or updated employee non-primary state tax information directly to Paylocity Payroll/HR solution. - [Create Employee Onboarding](https://developer.paylocity.com/integrations/reference/addonboarding.md): Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Paylocity Payroll/HR solution. - [Create an Employee Pay Rates Search](https://developer.paylocity.com/integrations/reference/search-for-pay-rates.md): > 🚧 Beta Phase > > This resource is in closed beta. Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at [marketplaceapisupport@paylocity.com](mailto:marketplaceapisupport@paylocity.com) **Summary Description** Performs a pay rates search for the specified company according to the search parameters passed in the request body. - [Get Employee Pay Statement Details Data for the Specified Year and Check Date](https://developer.paylocity.com/integrations/reference/gets-employee-pay-statement-detail-data-based-on-the-specified-year-and-check-date.md): Get pay statement details API will return employee pay statement detail data currently available in Paylocity Payroll/HR solution for the specified year and check date. - [Get Employee Pay Statement Details Data for the Specified Year](https://developer.paylocity.com/integrations/reference/gets-employee-pay-statement-detail-data-based-on-the-specified-year.md): Get pay statement details API will return employee pay statement details data currently available in Paylocity Payroll/HR solution for the specified year. - [Get Employee Pay Statement Summary Data for the Specified Year and Check Date](https://developer.paylocity.com/integrations/reference/gets-employee-pay-statement-summary-data-based-on-the-specified-year-and-check-date.md): Get pay statement summary API will return employee pay statement summary data currently available in Paylocity Payroll/HR solution for the specified year and check date. - [Get Employee Pay Statement Summary Data for the Specified Year](https://developer.paylocity.com/integrations/reference/gets-employee-pay-statement-summary-data-based-on-the-specified-year.md): Get pay statement summary API will return employee pay statement summary data currently available in Paylocity Payroll/HR solution for the specified year. - [Upsert Primary State Tax](https://developer.paylocity.com/integrations/reference/add-or-update-primary-state-tax.md): Sends new or updated employee primary state tax information directly to Paylocity Payroll/HR solution. - [Upsert Sensitive Data](https://developer.paylocity.com/integrations/reference/add-or-update-sensitive-data.md): Sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution. - [Get Sensitive Data](https://developer.paylocity.com/integrations/reference/get-sensitive-data.md): Gets employee sensitive data information directly from Paylocity Payroll/HR solution. - [Create an Employee Statuses Search](https://developer.paylocity.com/integrations/reference/search-for-employee-statuses.md): > 🚧 Beta Phase > > This resource is in closed beta. Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at [marketplaceapisupport@paylocity.com](mailto:marketplaceapisupport@paylocity.com) **Summary Description** Performs a employee status search for the specified company according to the search parameters passed in the request body. ## Recipes - [Getting Started with Assessments](https://developer.paylocity.com/integrations/recipes/getting-started-with-assessments.md) - [Getting Started with Company Punch Details API](https://developer.paylocity.com/integrations/recipes/getting-started-with-company-punch-details-api.md) - [Getting Started with LMS APIs](https://developer.paylocity.com/integrations/recipes/getting-started-with-lms-apis.md) - [Getting Started with Tip Management](https://developer.paylocity.com/integrations/recipes/getting-started-with-tip-management.md) - [Working with Employee Deductions in the Pay Setup API](https://developer.paylocity.com/integrations/recipes/working-with-employee-deductions-in-the-pay-setup-api.md) - [Working with Pay Statement Endpoints](https://developer.paylocity.com/integrations/recipes/working-with-pay-statement-endpoints.md) ## Changelog - [v2026-05-12 Released](https://developer.paylocity.com/integrations/changelog/v2026-05-12-released.md) - [Developer Portal Launch Readiness Workflow Released](https://developer.paylocity.com/integrations/changelog/developer-portal-in-app-launch-workflow-released.md) - [v2026-04-14 Released](https://developer.paylocity.com/integrations/changelog/v2026-04-14-released.md) - [v2026-03-10 Released](https://developer.paylocity.com/integrations/changelog/v2026-03-10-released.md) - [v2026-02-17 Released](https://developer.paylocity.com/integrations/changelog/v2026-02-17-released.md)