just/mocks_
mockzilla.org →
Catalog /hris /Paycor Public API

Paycor Public API

PROVIDER · Paycor SPEC v · OpenAPI 3.0.0 MOCK · LIVE
▸ TRY IT
https://api.justmocks.com/paycor
Open mock →

Mock the Paycor Public API to develop HR, payroll, and benefits integrations without a sandboxed Paycor tenant.

[01]

About

overview

Mock 114 endpoints of the Paycor Public API: employees, jobs, departments, locations, time off, payrolls, pay rates, deductions, taxes, and benefits. Useful for HR/payroll integrations, benefits-portal prototypes, or any HCM tool that consumes Paycor data.

Endpoints
114 across 48 resource groups
Methods
GET 75 · POST 19 · PUT 18 · DEL 2 none deprecated
OpenAPI
3.0.0 spec version
Source spec
623 KB · YAML
[02]

Endpoints

114 operations · 48 resource groups
GET /v1/legalEntities/{legalEntityId}/ats/{atsAccountId}/jobs
Applicant Tracking System
Get a list of ATS Account jobs for ATS Account Id
Data Access: View ATS Account jobs by ATS Account ID. Mocked via Mockzilla.
GET /v1/legalEntities/{legalEntityId}/ats/{atsAccountId}/jobs/{atsJobId}
Applicant Tracking System
Get an ATS Account Job for ATS Account Id
Data Access: View ATS Account Job by ATS Job Id
GET /v1/legalEntities/{legalEntityId}/ats/accounts
Applicant Tracking System
Get a list of ATS Accounts for Legal Entity
Data Access: View ATS Accounts By Legal Entity Id
POST /v1/employees/{employeeId}/emergencycontact
Employee Emergency Contact
Either Home Phone, Work Phone or Mobile Phone must be specified Data Access: Create Emergency Contact
GET /v1/employees/{employeeId}/certifications
Employee Certifications
Get a list of Employee Certifications for an employee
Data Access: View Certification Information for Employee
PUT /v1/employees/{employeeId}/certifications
Employee Certifications
Update Employee Certification
Data Access: Create and Update Certification. Available as a Mockzilla mock endpoint.
POST /v1/employees/{employeeId}/certifications
Employee Certifications
Add Employee Certification
Data Access: Create and Update Certification
GET /v1/employees/{employeeId}/customfields
Employee Custom Fields
Get Employee Custom Fields by EmployeeID
Data Access: View Employee Custom Fields
PUT /v1/employees/{employeeId}/customfields
Employee Custom Fields
Update Custom Field by EmployeeID
Data Access: Update Employee Custom Fields
GET /v1/employees/{employeeId}/deductions/{employeeDeductionId}
Employee Deductions
Get Employee Deduction by EmployeeID and EmployeeDeductionID
Data Access: View Employee Deduction Information
GET /v1/employees/{employeeId}/deductions
Employee Deductions
Get Employee Deductions by EmployeeID
Data Access: View Employee Deductions Information. Mockzilla mock: no signup, no API key.
POST /v1/employees/{employeeId}/deductions
Employee Deductions
Add Deduction to Employee
Tip: first call "Get Legal Entity Deductions by Legal Entity ID" to get the valid Deduction Codes Data Access: Add Employee Deduction
PUT /v1/employees/{employeeId}/deductions
Employee Deductions
Update Employee Deduction by EmployeeID
Data Access: Update Employee Deduction
GET /v1/employees/{employeeId}/HSAaccounts
Employee Direct Deposits
Get Employee HSA Direct Deposits by EmployeeID
Data Access: View Employee HSA Account Information
POST /v1/employees/{employeeId}/HSAaccounts
Employee Direct Deposits
Add Employee HSA Direct Deposits by EmployeeID
Data Access: Add Employee HSA Account
PUT /v1/employees/{employeeId}/HSAaccounts
Employee Direct Deposits
Update Employee HSA Direct Deposits by EmployeeID
Data Access: Update Employee HSA Account Information. Served by the Mockzilla mock runtime.
POST /v1/employees/{employeeId}/DirectDeposits
Employee Direct Deposits
Add Employee Direct Deposits by EmployeeID
Data Access: Add Employee Direct Deposit
GET /v1/employees/{employeeId}/DirectDeposits
Employee Direct Deposits
Get Employee Direct Deposits by EmployeeID
Data Access: View Employee Direct Deposit Information by Employee Id
PUT /v1/employees/{employeeId}/DirectDeposits
Employee Direct Deposits
Update Employee Direct Deposits by EmployeeID
Data Access: Update Employee Direct Deposit Information
GET /v1/employees/{employeeId}/DirectDeposits/{directDepositId}
Employee Direct Deposits
Get Employee Direct Deposit by EmployeeID and DirectDepositID
Data Access: View Employee Direct Deposit Information by Direct Deposit Id
GET /v1/employees/{employeeId}/paystubDocumentData
Employee Documents
Get Employee Pay Stubs document link by EmployeeID
Start Date and End Date are required parameters. Data Access: Get Employee Pay Stub Document Link. Mocked via Mockzilla.
GET /v1/employees/{employeeId}/PayStubDocument/{documentId}
Employee Documents
Download Employee Pay Stub Document
Data Access: Download Employee Pay Stub Document
GET /v1/employees/{employeeId}/earnings/{employeeEarningId}
Employee Earnings
Get Employee Earning by EmployeeID and EmployeeEarningID
Data Access: View Employee Earning Information
GET /v1/employees/{employeeId}/earnings
Employee Earnings
Get Employee Earnings by EmployeeID
Data Access: View Employee Earnings Information
POST /v1/employees/{employeeId}/earnings
Employee Earnings
Add Earning to Employee
Data Access: Add Employee Earning
PUT /v1/employees/{employeeId}/earnings
Employee Earnings
Update Employee Earning
Data Access: Update Employee Earning. Available as a Mockzilla mock endpoint.
POST /v1/legalentities/{legalEntityId}/payrollhours
Employee Payroll Hours
Add Employee Hours And Earnings To Paygrid
Required parameters in body are: IntegrationVendor, ProcessId, LegalEntityId, EmployeeNumber, DepartmentCode, EarningCode, BusinessStartDate Data Access: Import Employee Hours and Earnings to Paygrid
POST /v1/employees/{employeeId}/payrollhours
Employee Payroll Hours
Import Payroll Hours to Employee
Data Access: Import Payroll Hours to Employee
GET /v1/employees/{employeeId}/I9Verification
Employee I9 Verification
Get Employee I9 Verification by EmployeeID
Data Access: View I9 Verification
PUT /v1/employees/{employeeId}/I9Verification
Employee I9 Verification
Update I9 Verification by EmployeeID
Data Access: Edit I9 Verification
GET /v1/employees/{employeeId}/payrates
Employee Pay Rates
Get Employee Payrates by EmployeeID
Data Access: View Employee Payrates. Mockzilla mock: no signup, no API key.
POST /v1/employees/{employeeId}/payrates
Employee Pay Rates
Add Payrate to Employee
This immediately creates a new payrate related to an Employee in Paycor's system. There is no way to undo or reverse this operation. Data Access: Create Employee PayRates Sequence numbers must be consecutive and unique
PUT /v1/employees/{employeeId}/payrates/{payrateId}
Employee Pay Rates
Update Employee Payrate by EmployeeID
Data Access: Update Employee PayRates
GET /v1/employees/{employeeId}/payschedule
Employee Pay Schedule
Get Employee Pay Schedule by EmployeeID
This API will return upcoming pay scheduled for a given employee (upcoming check dates), or allow looking up the check date for specific pay period dates. You must either specify the exact Period Start & End Date, or leave them blank. Alternatively you may consider 'GET Legal Entity Pay Schedule' which takes a range parameter. You can look up pay period dates from 'GET Legal Entity Pay Schedule' (scheduled dates) or 'GET Legal Entity Pay Data' (actual dates) The actual pay dates may change depending on when the client admin processes payroll. Data Access: View Employee Pay Schedule
GET /v1/employees/{employeeId}/paystubs
Employee Pay Stubs
Get Employee Pay Stubs by EmployeeID
Note: Either CheckDate, ProcessDate or PlannerId is required as a parameter. You can find a list of valid dates by calling 'GET Legal Entity Pay Data by Legal Entity ID'. Data Access: View Paystub Information
GET /v1/legalentities/{legalEntityId}/paystubs
Employee Pay Stubs
Get Employee Pay Stubs by Legal Entity ID
Note: Either CheckDate, ProcessDate or PlannerId is required as a parameter. Data Access: View Paystub Information by Legal Entity Id. Served by the Mockzilla mock runtime.
GET /v1/employees/{employeeId}/paystubsytd
Employee Pay Stubs
Get Employee Pay Stubs YTD by EmployeeID
To Check Date is required parameter. To get a list of check dates, you can use the GET Legal Entity Pay data endpoint. Data Access: View Paystub Information YTD
GET /v1/legalentities/{legalEntityId}/paystubsytd
Employee Pay Stubs
Get Employee Pay Stubs YTD by Legal entity ID
To Check Date is required parameter. To get a list of check dates, you can use the GET Legal Entity Pay data endpoint. Data Access: View Paystub Information YTD By Legal Entity
GET /v1/employees/{employeeId}/schedules
Employee (Legacy / Perform Time) Schedules
Get Employee Schedules by EmployeeID
Date requirements: Start Date and End Date must not be more than one year ago Start Date must not be in future * Start date and end date range can be no greater than 90 days Data Access: View Legacy/Perform Employee Schedules by Employee Id
POST /v1/employees/{employeeId}/schedules
Employee (Legacy / Perform Time) Schedules
Add Schedule to Employee
Data Access: Create Legacy/Perform Time Employee Schedule
GET /v1/legalEntities/{legalEntityId}/schedules
Employee (Legacy / Perform Time) Schedules
Get Employee Schedules by Legal Entity ID
Date requirements: Start Date and End Date must not be more than one year ago Start Date must not be in future * Start date and end date range can be no greater than 90 days Data Access: View Legacy/Perform Employee Schedules by Legal Entity Id. Mocked via Mockzilla.
DEL /v1/employees/{employeeId}/schedules/{scheduleId}
Employee (Legacy / Perform Time) Schedules
Delete Employee Schedule
Data Access: Delete Legacy/Perform Time Employee Schedule
GET /v1/legalentities/{legalEntityId}/SchedulingJobs
Employee Scheduling
Get Scheduling Jobs by LegalEntityID
Data Access: View Legal Entity Scheduling Jobs
GET /v1/employees/{employeeId}
Employees
Get Employee by EmployeeID
Tip: you can retrieve a valid EmployeeID guid via endpoints like 'Get Employees by Legal Entity ID' Data Access: View Employee Information
PUT /v1/employees/{employeeId}
Employees
Update Employee Contact
This immediately updates an employee's contact information and associated Person's in Paycor's system. Data Access: Update Employee Contact
GET /v1/tenants/{tenantId}/employees
Employees
Get Employees By TenantID
Data Access: View Tenant Employees. Available as a Mockzilla mock endpoint.
GET /v1/legalentities/{legalEntityId}/employees
Employees
Get Employees by Legal Entity ID
Data Access: View Legal Entity Employees
POST /v1/employees
Employees
Create Employee
This immediately "hires" a new employee and associated Person in Paycor's system. There is no way to undo or reverse this operation. After creating an employee, please wait sixty seconds before using employeeId to call other endpoints. Data Access: Create Employee
PUT /v1/employees/{employeeId}/positionandstatus
Employees
Update Employee Position and Status data
This endpoint updates an employee's status and position information. Data Access: Update Employee Position And Status
PUT /v1/employees/{employeeId}/position
Employees
Update Employee Position data
This endpoint updates an employee's position information. Data Access: Update Employee Position
PUT /v1/employees/{employeeId}/status
Employees
Update Employee Status data
This endpoint updates an employee status information. Data Access: Update Employee Status Data. Mockzilla mock: no signup, no API key.
PUT /v1/employees/{employeeId}/identifyingdata
Employees
Update Employee Personal data
This endpoint updates an employee's personal information. Data Access: Update Employee Identifying Data
GET /v1/legalentities/{legalEntityId}/employeesIdentifyingData
Employees
GET Identifying Employee Data by Legal Entity Id
Data Access: View Legal Entity Employees Identifying Data Optional Data Access: View Legal Entity Employees SSN and BirthDate
PUT /v1/employees/{employeeId}/Paygroup
Employees
Update Employee Paygroup
This endpoint updates an employee's paygroup. Data Access: Update Employee Paygroup
POST /v1/employees/onboarding
Employee Onboarding
Create Employee Onboarding
This will allow partners to add a new employee entry for pending hire Data Access: Create Employee Onboarding
GET /v1/legalentities/{legalEntityId}/onboardingemployees
Employee Onboarding
Get employees in the onboarding state
This endpoint allows partners to see the employees in the onboarding state. Data Access: View Legal Entity Onboarding Employees. Served by the Mockzilla mock runtime.
GET /v1/employees/{employeeId}/taxes
Employee Taxes
Get Employee Taxes by EmployeeID
Data Access: View Employee Taxes
POST /v1/employees/{employeeId}/taxes
Employee Taxes
Add Tax by EmployeeID
* Use GET Tax Fields by Tax Code to determine payload needed to complete this call Data Access: Create Employee Tax
PUT /v1/employees/{employeeId}/taxes
Employee Taxes
Update Tax by EmployeeID
* Use GET Tax Fields by Tax Code to determine payload needed to complete this call Data Access: Update Employee Tax
GET /v1/employees/taxes/filingStatus/{taxCode}
Employee Taxes
Get Filing Status by Tax Code
Data Access: View Filing Status by Tax Code
GET /v1/employees/taxes/taxFields/{taxCode}
Employee Taxes
Get Tax Fields by Tax Code
This endpoint will allow you to pass in a Tax Code and will return the fields that are expected to be passed for PUT/POST Employee Taxes To get the Tax Codes available for your account to be used for this endpoint, use GET Legal Entity Taxes by Legal Entity ID Data Access: Get Tax Fields By Tax Code. Mocked via Mockzilla.
GET /v1/legalEntities/{legalEntityId}/punches
Employee Time Card Punches
Get Legal Entity Employees Time Card Punches by Legal Entity ID
This pulls Punches data from Paycor's Perform Time system, for one legal entity. Clients do not need to run payroll before hours are returned by this endpoint. Our Public API currently does not include whether the hours have already been Approved or not. Time Card hours may be delayed by 20 minutes. Date requirements: Start Date and End Date must not be more than one year ago Start Date must not be in future Start date and end date range can be no greater than 90 days Data Access: View Employee Time Card Punches By Legal Entity Id
GET /v1/employees/{employeeId}/punches
Employee Time Card Punches
Get Legal Entity Employees Time Card Punches by Employee ID
This pulls Punches data from Paycor's Perform Time system for one employee. Clients do not need to run payroll before hours are returned by this endpoint. Our Public API currently does not include whether the hours have already been Approved or not. Time Card punches may be delayed by 20 minutes. Date requirements: Start Date and End Date must not be more than one year ago Start Date must not be in future Start date and end date range can be no greater than 90 days Data Access: View Employee Time Card Punches
GET /v1/employees/{employeeId}/timeoffaccruals
Employee Time Off Accruals
Get Employee Accruals by EmployeeID
Data Access: View Employee Timeoff Accruals by Employee Id
GET /v1/legalentities/{legalEntityId}/timeoffaccruals
Employee Time Off Accruals
Get Employee Accruals by Legal Entity ID
Data Access: View Employee Timeoff Accruals by Legal Entity Id
GET /v1/employees/{employeeId}/timeoffrequests
Time Off Requests
Get Employee Time Off Requests by EmployeeId
Date requirements: Start Date and End Date must not be more than one year ago Start date and end date range can be no greater than 90 days Data Access: View Timeoff Requests by Employee Id. Available as a Mockzilla mock endpoint.
POST /v1/events/mockevent
Events
Mock Event Notification
Following body attributes are optionally required: ItemId is required when EventType is Employee.Modified LegalEntityId is required when EventType is LegalEntity.Modified
GET /v1/generalledger/legalentities/{legalEntityId}
General Ledger
Get General Ledger by Legal Entity ID
Type of report can be Regular or Setup Setup report returns only department number, company department number, account name, account number, itemize, and sort sequence all other values are set to null. Regular report returns all data. Planner id is required if report type is set to regular Data Access: View General Ledger
GET /v1/generalledger/jobcosting/legalentities/{legalEntityId}
General Ledger Job Costing
Get General Ledger Job Costing by Legal Entity ID
Data Access: View General Ledger Job Costing
GET /v1/legalentities/{legalEntityId}/laborcategories
Labor Categories
Get Labor Categories by Legal Entity ID
To make this call you will need the Job Costing or Workforce Management Service. Data Access: View Labor Categories by Legal Entity Id
POST /v1/legalentities/{legalEntityId}/laborcodes
Labor Codes
Add Labor Code to Legal Entity
This immediately creates a new labor code related to a Legal Entity in Paycor's system. There is no way to undo or reverse this operation. Required body attributes: LaborCategoryId Code LaborCodeName To make this call you will need the Job Costing or Workforce Management Service. Data Access: Create and Update Labor Codes. Mockzilla mock: no signup, no API key.
GET /v1/legalentities/{legalEntityId}/laborcodes
Labor Codes
Get Labor Code By Legal Entity ID
Returns list of all Labor Code items. * Labor code is not active if effective start date is after current date or if effective end date is before current date. To make this call you will need the Job Costing or Workforce Management Service. Data Access: View Labor Codes by Legal Entity Id
PUT /v1/legalentities/{legalEntityId}/laborcodes
Labor Codes
Update Labor Code
This operation updates specified labor code in Paycor's system. To make this call you will need the Job Costing or Workforce Management Service. LaborCodeId is required. Data Access: Create and Update Labor Codes
GET /v1/legalentities/{legalEntityId}
Legal Entities
GET /v1/legalentities/ActivatedLegalEntityTenantList
Legal Entities
Get Legal Entities/Tenants for the user logged in
GET /v1/legalentities/{legalEntityId}/certificationOrganizations
Legal Entity Certifications
Get a list of Certification Organizations for a Legal Entity
Data Access: View Certification Organizations for Legal Entity
GET /v1/legalentities/{legalEntityId}/certifications
Legal Entity Certifications
Get a list of Certifications for a Legal Entity
Tip: you can retrieve a list of certiifcates via endpoints like 'Get Certificates by Legal Entity ID' Data Access: View Certification Information for Legal Entity
GET /v1/legalentities/{legalEntityId}/deductions
Legal Entity Deductions
Get Legal Entity Deductions by Legal Entity ID
Data Access: View Legal Entity Employees. Served by the Mockzilla mock runtime.
GET /v1/legalentities/{legalEntityId}/departments
Legal Entity Departments
Get Legal Entity Departments by Legal Entity ID
Data Access: View Legal Entity Departments Information
POST /v1/legalentities/{legalEntityId}/departments
Legal Entity Departments
Create Departments by Legal Entity Id
Creates new Department for a Legal Entity. * the newly created Department will take at least 60 seconds to propagate through the system Data Access: Create and Update Legal Entity Departments
PUT /v1/legalentities/{legalEntityId}/departments
Legal Entity Departments
Update Legal Entity Department by Legal Entity ID
Updates existing Department for a Legal Entity. The update of the Department will take at least 60 seconds to propagate through the system When updating top level departments, payroll id should be used as parent id Data Access: Create and Update Legal Entity Departments
GET /v1/legalentities/{legalEntityId}/departments/{departmentId}
Legal Entity Departments
Get Legal Entity Department by Legal Entity ID and Department ID
Data Access: View Legal Entity Departments by Department Id
GET /v1/legalentities/{legalEntityId}/earnings
Legal Entity Earnings
GET /v1/legalentities/{legalEntityId}/jobtitles
Legal Entity Job Titles
Get Job Titles by Legal Entity ID
Job Titles are configured at a Tenant level, unlike most other objects which are configured at a Legal Entity level. Data Access: View Legal Entity Job Titles. Mocked via Mockzilla.
GET /v1/legalentities/{legalEntityId}/paydata
Legal Entity Pay Data
Get Legal Entity Pay Data by Legal Entity ID
This endpoint returns the dates that particular employees were actually paid. You can retrieve all employees by not passing EmployeeId, or you can pass EmployeeId to filter. The returned values (Check Date or Process Date) can be used as an input for GET Employee Pay Stubs. Only dates from provided fromCheckDate and toCheckDate are used. Requires exactly one filtering parameter to be passed in. Choose one of these three: Check Date range: parameters fromCheckDate and toCheckDate Process Date: the single date the payrun was processed. PlannerID: You can retrieve your Planner ID by using the Legal Entity Payroll Processing Data endpoint. Returns one object per pay date, even if there were multiple paychecks on that same date. * Does include Additional Payruns, which don't have to follow the schedule and can be used for bonuses. Data Access: View Paydata Information
GET /v1/legalentities/{legalEntityId}/payGroups
Legal Entity Pay Groups
Get Pay Groups by Legal Entity ID
Data Access: View Legal Entity Pay Groups
GET /v1/legalentities/{legalEntityId}/payrollProcessing
Legal Entity Payroll Processing Data
GET Payroll Processing Data by Legal Entity
* If fromCheckDate is not provided, current date will be used. Data Access: View Legal Entity Payroll Processing Data
GET /v1/legalentities/{legalEntityId}/payschedule
Legal Entity Pay Schedule
Get Legal Entity Pay Schedule by Legal Entity ID and Paygroup ID
This returns the schedule of regularly-scheduled payruns for a given Paygroup and date range. Tip: first list the Paygroups within a Legal Entity using GET Legal Entity Pay Groups, in order to populate the payGroupId parameter Tip: You can take the returned Check Dates or Process Dates and pass into Get Employee Pay Stubs by EmployeeID Note that query parameters PayGroupId, AsOfDate and UntilDate are required. Data Access: View Pay Schedule Information
GET /v1/legalentities/{legalEntityId}/activitytypes
Legal Entity Activity Types
Get Legal Entity Activity Types by Legal Entity ID
GET /v1/legalentities/{legalEntityId}/schedulegroups
Legal Entity Schedule Groups
Get Schedules Groups for Legal Entity
Data Access: View Legal Entity Schedule Groups. Available as a Mockzilla mock endpoint.
GET /v1/legalentities/{legalEntityId}/services
Legal Entity Services
Get subscribed services for Legal Entity
Data Access: View Legal Entity Services
GET /v1/legalentities/{legalEntityId}/statusReasons/{statusCategory}
Legal Entity Status Reason
Get Legal Entity Status Reason values
Data Access: Legal Entity Status Reason
GET /v1/legalentities/{legalEntityId}/taxes
Legal Entity Taxes
Get Legal Entity Taxes by Legal Entity ID
Data access: View Legal Entity Taxes
POST /v1/legalentities/{legalEntityId}/CreatePunches
Legal Entity Time Data
Create Punches for Employee(s) under Legal Entity
Data access: Create Punches for Employee(s)
POST /v1/legalentities/{legalEntityId}/CreateHours
Legal Entity Time Data
Create Hours for Employee(s) under Legal Entity
Data access: Create Hours for Employee(s). Mockzilla mock: no signup, no API key.
GET /v1/legalentities/{legalEntityId}/punchErrorLog/{trackingId}
Legal Entity Time Data
Get Punch error logs by Legal Entity Id And Tracking Id
Data Access: View Punch Error log
GET /v1/legalentities/{legalEntityId}/HourErrorLog/{trackingId}
Legal Entity Time Data
Get Employee Hour error logs by Legal Entity Id And Tracking Id
Data Access: View Hour Error log.
GET /v1/legalentities/{legalEntityId}/timeoffrequests
Time Off Requests
Get Employee Time Off Requests by Legal Entity Id
Date requirements: Start Date and End Date must not be more than one year ago Start date and end date range can be no greater than 90 days Data Access: View Timeoff Requests by Legal Entity Id
GET /v1/legalentities/{legalEntityId}/timeoffRequests/{timeoffRequestId}
Time Off Requests
Get Employee Timeoff Request by Legal Entity Id And Timeoff Request Id
Data Access: View Timeoff Requests by Timeoff Request Id
GET /v1/legalentities/{legalEntityId}/timeOffRequestsErrorLog/{trackingId}
Time Off Requests
Get Employee Timeoff Request error logs by Legal Entity Id And Tracking Id
Data Access: View Timeoff Requests Error log by Legal entity Id and Tracking Id. Served by the Mockzilla mock runtime.
GET /v1/legalentities/{legalEntityId}/timeofftypes
Legal Entity Time Off Types
Get Legal Entity Time Off Types
Data Access: View Time Off Types
GET /v1/legalentities/{legalEntityId}/worklocations
Legal Entity Work Locations
Get a list of Work Locations for a Legal Entity
Data Access: View Legal Entity Work Locations
POST /v1/legalentities/{legalEntityId}/worklocations
Legal Entity Work Locations
Add Work Location By Legal Entity ID
Data Access: Create Legal Entity Work Location
PUT /v1/legalentities/{legalEntityId}/worklocations
Legal Entity Work Locations
Update Work Location By Legal Entity ID
Data Access: Update Legal Entity Work Location
DEL /v1/legalentities/{legalEntityId}/worklocations/{workLocationId}
Legal Entity Work Locations
Delete Work Location By Work Location ID And Legal Entity ID
Data Access: Delete Legal Entity Work Location. Mocked via Mockzilla.
GET /v1/legalentities/{legalEntityId}/worklocations/{workLocationId}
Legal Entity Work Locations
Get a Work Location for a Legal Entity By Legal Entity ID and Work Location ID
Data Access: View Legal Entity Work Location
GET /v1/legalentities/{legalEntityId}/worksites
Legal Entity Work Sites
Get Work Sites for Legal Entity
Data Access: View Legal Entity Work Sites
GET /v1/legalEntities/{legalEntityId}/persons
Persons
Get Persons by Legal Entity ID
Data Access: View Legal Entity Persons
GET /v1/tenants/{tenantId}/persons
Persons
Get Persons By TenantID
PersonList provides a subset of the full Person fields. Data Access: View Tenant Persons
GET /v1/tenants/{tenantId}/persons/{personId}
Persons
Get Person By TenantID And PersonID
Note that PersonID and TenantID must always be passed together. Data Access: View Person Information. Available as a Mockzilla mock endpoint.
GET /v1/employees/{employeeId}/person
Persons
Get Person by EmployeeID
Data Access: View Employee Person
GET /v1/tenants/{tenantId}
Tenants
Get Tenant by TenantID
Data Access: View Tenant Information
GET /v1/tenants/{tenantId}/worklocations
Tenants
Get Tenant Work Locations by TenantID
Work Locations are configured at a Tenant level, unlike most other objects which are configured at a Legal Entity level. Data Access: View Tenant Work Locations
GET /v1/tenants/{tenantId}/jobtitles
Job Titles
Get All Job Titles by Tenant ID
Job Titles are configured at a Tenant level, unlike most other objects which are configured at a Legal Entity level. Data Access: View Tenant Job Titles