Getting Started
How to start building your integration using Paylocity APIs
Tools for our customers and partners
Welcome to the Paylocity developer experience for building integrations!
Whether you're a seasoned group that has already launched an integration with Paylocity or a development team starting your journey, this site will provide you with up-to-date information on the APIs we offer, how to interact with them, and the requirements for each phase of your integration project. If you are new to building integrations with Paylocity, check out our Integrations FAQ and be sure to review our API use policy.
Feedback
Want to praise us for a particular piece of well-documented information?
Perhaps you are feeling frustrated or confused by something you’ve read or can’t find.Scroll to the bottom any guide or specification and let us know by using the feedback buttons:
Please be sure to provide details on what you liked, didn’t like, or felt was missing.
Building an integration with Paylocity: Overview
Paylocity offers a robust set of APIs that allow customers and partners to access desired data quickly and securely. The APIs work seamlessly across our platform, making us the ideal partner in the HCM space. This guide will walk you through the high-level steps to build an integration with Paylocity.
Step 1: Integration project discovery
Before kicking off your project, there's some important information for you to review:
- Know what APIs you need access to and make sure that we have the right endpoints to solve your business need.
- Understand the Integration Requirements for go-live review and approval.
- If you want to become a technology partner, be sure you meet our Technology Partner Requirements so that your integration can be showcased in the Paylocity Integrations Marketplace.
Step 2: Setup contacts & legal information
To request access to a demo environment to test your integration, follow the instructions provided in our Integration Requirements guide.
Approval Requirement
To be approved to access a demo environment, you must be an existing Paylocity customer or have at least one (1) existing Paylocity customer willing to participate in early adoption testing, advocate for the level of access required to drive your integration, and provide appropriate customer signoff to change requests for your integration access during development & testing.
Step 3: Receive credentials for sandbox access
When the access request has been reviewed and approved, Paylocity will contact you and provide OAUTH credentials and access to a Sandbox account. These credentials will be necessary for authenticating your API requests. See Authentication for more information on security.
Step 4: Build your integration
Leverage our guides, API Specifications, and code samples to build your integration. These resources will help you understand the API's functionality and assist you in implementing it effectively.
Step 5: Test your integration
Before submitting your integration for review, test it in the Sandbox environment provided by Paylocity. This will allow you to identify and fix any issues before moving forward.
Step 6: Go-live and plan your launch
After finalizing your integration, plan and go-live with your solution.
Step 7: Work with Paylocity Partner Relations
If you are interested in becoming a Paylocity technology partner, you will work with the Paylocity Partner Relations team to make sure you've met our Technology Partner Requirements. This collaboration ensures that both parties understand and agree upon clear definitions of legal responsibilities.
Step 8: Integration requests
Once your integration is live, you will provide steps in the Marketplace Guide for customers to request the integration once logged in as an administrator to the Paylocity solution. Customers can reach out to [email protected] for assistance using our customer admin experience for the Integrations Marketplace.
By following these steps, you'll be well on your way to integrating with the Paylocity API and increasing the adoption of your integration. Paylocity's commitment to providing an accessible, secure, and scalable API will help you deliver the best possible solutions to our users.
Updated 9 months ago