Retrieves a paged list of employees with enriched job and location data. At least one date filter (ModifiedOnStart or ModifiedOnEnd) and at least one location scope (locations or legalEntities) are required.
Security
The requesting user must have the following permission to retrieve employees:
- Labor → Employees → View Employees
Field-level restrictions: the fields below each require an additional permission. A user who does not hold it receives the rest of the employee record with that field omitted from the response — the request still succeeds.
| Field | Additional permission required |
|---|---|
posEmployeeId |
Labor → Employees → POS Employees → View POS Employees |
birthdate |
Labor → Employees → Basic Info → PII → View PII |
paySchedule |
Labor → Employees → Employment → Pay Type → View Pay Type |
payrollId |
Labor → Employees → Employment → Payroll ID → View Payroll ID |
payRate |
Labor → Employees → Employment → Hourly Pay Rates → View Hourly Pay Rates or Labor → Employees → Employment → Salary Pay Rates → View Salary Pay Rates |
primaryJob, otherJobs |
Labor → Employees → Employment → Hourly Job Info → View Hourly Job Info or Labor → Employees → Employment → Salary Job Info → View Salary Job Info |
Identifies the R365 tenant the request applies to. Required on every request.
Start of the modified-on date range (inclusive). If provided alone the query is scoped to that single day
End of the modified-on date range (inclusive). If provided alone the query is scoped to that single day
Comma-separated list of R365 Location GUIDs to filter results. If omitted, all accessible locations are included
Comma-separated list of R365 Legal Entity GUIDs to filter results. If omitted, all accessible legal entities are included
Maximum number of top-level objects to return in one page.
Opaque token from NextLink of a prior response. Omit on the first request; pass verbatim to fetch the next page
Paged response containing employees for the requested page and a link to the next page when available.
Employees for the current page.
R365 employee identifier.
POS system employee identifier.
Employee first name.
Employee last name.
Employee date of birth.
Employee pay rate.
Pay schedule type (e.g. Hourly, Salary).
Indicates whether the employee is inactive.
Employee hire date. Null when not recorded.
Employee termination date, if applicable.
External payroll system identifier.
Location identifier.
Location name.
Location number.
Primary job assignment. Null when no primary job is recorded.
Job identifier.
Job title name.
Job code.
Department name.
Additional location assignments.
Location identifier.
Location name.
Location number.
Additional job assignments.
Job identifier.
Job title name.
Job code.
Department name.
Relative URL to retrieve the next page of results. Null when this is the last page.
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.