For general questions and support of the API, contact: [email protected] # Overview Paylocity Web Services API is an externally facing RESTful Internet protocol. The Paylocity API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Requ
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.paylocity.com/api
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
For general questions and support of the API, contact: [email protected] # Overview Paylocity Web Services API is an externally facing RESTful Internet protocol. The Paylocity API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON. Paylocity supports v1 and v2 versions of its API e
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/companies/{companyId}/codes/{codeResource} | Get All Company Codes Get All Company Codes for the selected company and resource Company Codes |
GET | /v2/companies/{companyId}/customfields/{category} | Get All Custom Fields Get All Custom Fields for the selected company Custom Fields |
POST | /v2/companies/{companyId}/employees | Add new employee New Employee API sends new employee data directly to Web Pay. Companies who use the New Hire |
GET | /v2/companies/{companyId}/employees/ | Get all employees Get All Employees API will return employee data currently available in Web Pay. Employee |
GET | /v2/companies/{companyId}/employees/{employeeId} | Get employee Get Employee API will return employee data currently available in Web Pay. Employee |
PATCH | /v2/companies/{companyId}/employees/{employeeId} | Update employee Update Employee API will update existing employee data in WebPay. Employee |
PUT | /v2/companies/{companyId}/employees/{employeeId}/additionalRates | Add/update additional rates Sends new or updated employee additional rates information directly to Web Pay. Ad |
PUT | /v2/companies/{companyId}/employees/{employeeId}/benefitSetup | Add/update employee's benefit setup Sends new or updated employee benefit setup information directly to Web Pa |
GET | /v2/companies/{companyId}/employees/{employeeId}/directDeposit | Get All Direct Deposit Get All Direct Deposit returns main direct deposit and all additional direct depositsfo |
GET | /v2/companies/{companyId}/employees/{employeeId}/earnings | Get All Earnings Get All Earnings returns all earnings for the selected employee. Earnings |
PUT | /v2/companies/{companyId}/employees/{employeeId}/earnings | Add/Update Earning Add/Update Earning API sends new or updated employee earnings information directly to Web P |
GET | /v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode} | Get Earnings by Earning Code Get Earnings returns all earnings with the provided earning code for the selected |
GET | /v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate} | Get Earning by Earning Code and Start Date Get Earnings returns the single earning with the provided earning c |
DELETE | /v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate} | Delete Earning by Earning Code and Start Date Delete Earning by Earning Code and Start Date Earnings |
PUT | /v2/companies/{companyId}/employees/{employeeId}/emergencyContacts | Add/update emergency contacts Sends new or updated employee emergency contacts directly to Web Pay. Emergency |
GET | /v2/companies/{companyId}/employees/{employeeId}/localTaxes | Get all local taxes Returns all local taxes for the selected employee. Local Taxes |
POST | /v2/companies/{companyId}/employees/{employeeId}/localTaxes | Add new local tax Sends new employee local tax information directly to Web Pay. Local Taxes |
GET | /v2/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode} | Get local taxes by tax code Returns all local taxes with the provided tax code for the selected employee. Loca |
DELETE | /v2/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode} | Delete local tax by tax code Delete local tax by tax code Local Taxes |
PUT | /v2/companies/{companyId}/employees/{employeeId}/nonprimaryStateTax | Add/update non-primary state tax Sends new or updated employee non-primary state tax information directly to W |
GET | /v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year} | Get employee pay statement details data for the specified year. Get pay statement details API will return empl |
GET | /v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}/{checkDate} | Get employee pay statement details data for the specified year and check date. Get pay statement details API w |
GET | /v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year} | Get employee pay statement summary data for the specified year. Get pay statement summary API will return empl |
GET | /v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}/{checkDate} | Get employee pay statement summary data for the specified year and check date. Get pay statement summary API w |
PUT | /v2/companies/{companyId}/employees/{employeeId}/primaryStateTax | Add/update primary state tax Sends new or updated employee primary state tax information directly to Web Pay. |
GET | /v2/companies/{companyId}/employees/{employeeId}/sensitivedata | Get sensitive data Gets employee sensitive data information directly from Web Pay. Sensitive Data |
PUT | /v2/companies/{companyId}/employees/{employeeId}/sensitivedata | Add/update sensitive data Sends new or updated employee sensitive data information directly to Web Pay. Sensit |
GET | /v2/companies/{companyId}/openapi | Get Company-Specific Open API Documentation The company-specific Open API endpoint allows the client to GET an |
POST | /v2/credentials/secrets | Obtain new client secret. Obtain new client secret for Paylocity-issued client id. See Setup section for detai |
POST | /v2/weblinkstaging/companies/{companyId}/employees/newemployees | Add new employee to Web Link Add new employee to Web Link will send partially completed or potentially erroneo |
specification origin: https://api.paylocity.com/api/v2/openapi
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.