Configure Connection
Paylocity guide
Arrange API access, configure Paylocity endpoints and client credentials in NIM, and validate employee data for downstream provisioning.
Before you beginDirect link to Before you begin
Follow Paylocity's Getting Started API documentation to request access and complete the vendor's integration requirements. Paylocity provides OAuth credentials and sandbox access after approving the access request; test in the approved environment before production use.
NIM requires Tenant URL, Token URI, Client ID, Client Secret, and Company ID.
Obtain endpoints and client credentialsDirect link to Obtain endpoints and client credentials
- Follow the vendor's access request and approval process for your integration.
- Obtain the Tenant URL, authentication Token URI, Client ID, and Client Secret for the intended environment.
- Obtain the Company ID and confirm that the integration can read the employee data required by your downstream process.
- Store the client secret securely and confirm the appropriate sandbox or production endpoint values before configuring NIM.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Paylocity system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The Paylocity API tenant address for your environment, using the format expected by the Connection screen. |
| Token URI | The authentication token endpoint supplied for the integration. |
| Client ID | The client identifier authorized for API access. |
| Client Secret | The secret associated with that client. |
| Company ID | The company identifier used as {company_id} in the employee test endpoint. |
Test employee retrievalDirect link to Test employee retrieval
-
Select Test Connection. NIM attempts to retrieve employees using:
GET /companies/{company_id}/employees?pageSize=1 -
If the test fails, verify the Tenant URL, Token URI, client credentials, Company ID, network access, and employee API permissions.
-
Collect the employee data required by your process and confirm that the expected company records are present.
-
Validate employee matching and field mappings before using the data for downstream user provisioning.
The connection test checks employee retrieval. Validate other collections and field access required by your process separately.