Skip to content
HRIS & payroll

paylocity.com

Paylocity sandbox and mock API

For general questions and support of the API, contact: webservices@paylocity.com # 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 endpoi Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
30
Collections
-
Event types
-
Start this simulation Vendor documentation
example request
curl https://your-paylocity.slurry.io/api/v2/companies/123/codes/123 \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 2.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 30.

  • GET/v2/companies/{companyId}/codes/{codeResource}
  • GET/v2/companies/{companyId}/customfields/{category}
  • POST/v2/companies/{companyId}/employees
  • GET/v2/companies/{companyId}/employees/
  • GET/v2/companies/{companyId}/employees/{employeeId}
  • PATCH/v2/companies/{companyId}/employees/{employeeId}
  • PUT/v2/companies/{companyId}/employees/{employeeId}/additionalRates
  • PUT/v2/companies/{companyId}/employees/{employeeId}/benefitSetup
  • GET/v2/companies/{companyId}/employees/{employeeId}/directDeposit
  • GET/v2/companies/{companyId}/employees/{employeeId}/earnings
  • PUT/v2/companies/{companyId}/employees/{employeeId}/earnings
  • GET/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}