# Paylocity | Recruiting Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://paylocity-develop.ferndocs.com/recruiting/_mcp/server ## Docs - [Getting started](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/getting-started/getting-started.md): How to start building your integration using Paylocity APIs - [Using Postman](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/getting-started/using-postman.md) - [Using Developer Portal](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/getting-started/using-developer-portal.md) - [Integrations FAQ](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/integrations-faq.md) - [Integration implementation best practices](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/integration-implementation-best-practices.md) - [Common integration use cases](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/common-integration-use-cases.md) - [Integration deliverables by phase](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/integration-requirements/integration-deliverables-by-phase.md) - [Data element & directionality mapping](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/integration-requirements/data-element-directionality-mapping.md) - [Partner landing page requirements overview](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/technology-partner-requirements/partner-landing-page-requirements-overview.md) - [Integration platforms](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/technology-partner-requirements/integration-platforms.md) - [Company & company sets](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/company-company-sets.md) - [Employee status](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/employee-status.md) - [Employee transfers](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/employee-transfers.md) - [List & lookup values](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/list-lookup-values.md) - [Pay setup - deductions & earnings](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/pay-setup-deductions-earnings.md) - [Punch data imports](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/punch-data-imports.md) - [Synchronization & webhooks](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/paylocity-key-concepts/synchronization-webhooks.md) - [Getting support](https://paylocity-develop.ferndocs.com/recruiting/guides/general-use-guides/getting-support.md) - [Changelog](https://paylocity-develop.ferndocs.com/recruiting/changelog/llms.txt) ## API Docs - Paylocity APIs > Authentication [Get Bearer Token](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/authentication/get-bearer-token.md) - Paylocity APIs > Assessments Packages [Get Assessment Packages](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-packages/get-assessment-packages.md) - Paylocity APIs > Assessments Packages [Upsert Assessment Packages [Batch]](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-packages/upsert-assessment-packages-batch.md) - Paylocity APIs > Assessments Packages [Upsert Assessment Package](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-packages/upsert-assessment-package.md) - Paylocity APIs > Assessments Packages [Delete Assessment Package](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-packages/delete-assessment-package.md) - Paylocity APIs > Assessments Subscription [Upsert Subscription](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-subscription/upsert-subscription.md) - Paylocity APIs > Background Check Client Onboarding [Add Billing Codes](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/add-billing-codes.md) - Paylocity APIs > Background Check Client Onboarding [Get Company Billing Codes](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/get-company-billing-codes.md) - Paylocity APIs > Background Check Client Onboarding [Delete Billing Code](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/delete-billing-code.md) - Paylocity APIs > Background Check Client Onboarding [Update Billing Code Status](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/update-billing-code-status.md) - Paylocity APIs > Background Check Client Onboarding [Upsert Onboarding Status](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/upsert-onboarding-status.md) - Paylocity APIs > Background Check Client Onboarding [Get client onboardings](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-client-onboarding/get-client-onboardings.md) - Paylocity APIs > Background Check Screening Package [Get Screening Packages](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-package/get-screening-packages.md) - Paylocity APIs > Background Check Screening Package [Upsert Screening Packages [Batch]](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-package/upsert-screening-packages-batch.md) - Paylocity APIs > Background Check Screening Package [Upsert Screening Package](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-package/upsert-screening-package.md) - Paylocity APIs > Background Check Screening Package [Delete Screening Package](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-package/delete-screening-package.md) - Paylocity APIs > Background Check Business Unit [Get Company Business Units](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-business-unit/get-company-business-units.md) - Paylocity APIs > Background Check Business Unit [Add Business Units](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-business-unit/add-business-units.md) - Paylocity APIs > Background Check Business Unit [Get Business Unit](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-business-unit/get-business-unit.md) - Paylocity APIs > Background Check Business Unit [Update Business Unit](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-business-unit/update-business-unit.md) - Paylocity APIs > Background Check Business Unit [Delete Business Unit](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-business-unit/delete-business-unit.md) - Paylocity APIs > Background Check Screening Order [Update Screening Order Status](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-order/update-screening-order-status.md) - Paylocity APIs > Background Check Screening Order [Get Screening Orders for Partner](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-screening-order/get-screening-orders-for-partner.md) - Paylocity APIs > Learning Management API [Create Training Content [Single]](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/learning-management-api/create-training-content-single.md) - Paylocity APIs > Learning Management API [Get Training Content [Batch]](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/learning-management-api/get-training-content-batch.md) - Paylocity APIs > Learning Management API [Get Training Content [Single]](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/learning-management-api/get-training-content-single.md) - Paylocity APIs > Assessments Callback [Get Callback](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-callback/get-callback.md) - Paylocity APIs > Assessments Callback [Upsert Callback](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-callback/upsert-callback.md) - Paylocity APIs > Assessments Callback [Delete Callback](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-callback/delete-callback.md) - Paylocity APIs > Assessments Order [Get Partner Assessment Orders](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-order/get-partner-assessment-orders.md) - Paylocity APIs > Assessments Order [Update Assessment Order](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/assessments-order/update-assessment-order.md) - Paylocity APIs > Background Check Subscription [Get Webhook for Candidate Screening Order](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-subscription/get-webhook-for-candidate-screening-order.md) - Paylocity APIs > Background Check Subscription [Create Webhook for Candidate Screening Order](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-subscription/create-webhook-for-candidate-screening-order.md) - Paylocity APIs > Background Check Subscription [Delete Webhook for Candidate Screening Order](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/background-check-subscription/delete-webhook-for-candidate-screening-order.md) - Paylocity APIs > Partner Onboarding [Get Onboarding Status](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/partner-onboarding/get-onboarding-status.md) - Paylocity APIs > Partner Onboarding [Upsert Onboarding Status](https://paylocity-develop.ferndocs.com/recruiting/api-reference/paylocity-ap-is/partner-onboarding/upsert-onboarding-status.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://paylocity-develop.ferndocs.com/recruiting/openapi.json) - [OpenAPI YAML](https://paylocity-develop.ferndocs.com/recruiting/openapi.yaml)