Paycor REST Connector
API Documentation
Section titled “API Documentation”The vendor API reference covers this connector's endpoints.
Paycor Setup
Section titled “Paycor Setup”The Paycor API Application and Initiation process is a little more involved than other REST providers. Please be sure to go through the steps outlined on their Quick Start Page
Key values you must capture are:
- Application OAuth Client ID
- Application OAuth Client Secret
- APIm Subscription Key
- Scope Key of
currentapplication version
Activate it here, choosing Production or Sandbox depending on your need:
| Environment | Activation Form URL |
|---|---|
| Sandbox | https://hcm-demo.paycor.com/AppActivation/ClientActivation |
| Production | https://hcm.paycor.com/AppActivation/ClientActivation |
Configuration
Section titled “Configuration”These fields appear when creating or editing this connection.
Identification
Section titled “Identification”| Field | Type | Description |
|---|---|---|
| Name | Text | Display name for this connection. |
| Alias | Text (multi-line) | Optional alias or notes about the connection. |
| Is active | Toggle | Whether the connection is enabled. Disable to pause without deleting. |
| Db read only | Toggle | Restrict the connection to read-only operations. |
| Access type | Select | Read-only, write-only, or read-write access level for this connection. |
Credentials
Section titled “Credentials”Enter the three values you captured during Paycor Setup. You do not enter a host or token URL — PlaidCloud supplies the Paycor API host and OAuth2 token endpoint for you.
| Field | Type | Description |
|---|---|---|
| Oauth2 client id | Text | The Application OAuth Client ID from your Paycor app registration. |
| Oauth2 client secret | Password | The Application OAuth Client Secret. Stored encrypted. |
| Paycor subscription key | Text | The APIm Subscription Key for your Paycor application. |
Authentication
Section titled “Authentication”Paycor uses OAuth2 with an authorization-code grant, so entering the credentials is only the first half — you also complete a one-time login with Paycor that authorizes PlaidCloud to pull your data.
- Enter the credentials and save. After you fill in the three values above and click Create (or Update), PlaidCloud opens a Paycor authorization window.
- Log in and approve. Sign into Paycor in that window and approve access. Paycor sends you back to PlaidCloud, which stores a refresh token on the connection and uses it to obtain access tokens automatically from then on.
The API host (apis.paycor.com) and token endpoint (https://apis.paycor.com/sts/v1/common/token) are managed by PlaidCloud. There are no URL fields to fill in, and you should not need to edit them.
Re-Authorizing an Expired Connection
Section titled “Re-Authorizing an Expired Connection”Paycor access can lapse — the refresh token expires or is revoked, or the Paycor application is deactivated. When that happens, workflows that use the connection stop authenticating and fail. To restore it:
- Confirm the Paycor application is still activated (see the activation URLs under Paycor Setup).
- Open the connection and click Update to re-run the Paycor authorization, then log in and approve. This mints a fresh refresh token and the connection resumes.