Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/labor/employees

Prev Next
Get
/public/v1/labor/employees

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
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
ModifiedOnStart
string (date)

Start of the modified-on date range (inclusive). If provided alone the query is scoped to that single day

ModifiedOnEnd
string (date)

End of the modified-on date range (inclusive). If provided alone the query is scoped to that single day

locations
string

Comma-separated list of R365 Location GUIDs to filter results. If omitted, all accessible locations are included

legalEntities
string

Comma-separated list of R365 Legal Entity GUIDs to filter results. If omitted, all accessible legal entities are included

pageSize
integer (int32)

Number of records to return per page. Defaults to 250

Minimum1
Maximum250
Default250
continuationToken
string

Opaque token from a prior response's NextLink. Omit on the first request; pass verbatim to fetch the next page

Responses
200

Paged response containing employees for the requested page and a link to the next page when available.

Expand All
object
data
Array of object (R365.Services.Employee.Contract.EmployeeExternal.Apis.ExternalEmployeeResponse)

Employees for the current page.

object
employeeId
string (uuid)

R365 employee identifier.

posEmployeeId
string | null

POS system employee identifier.

firstName
string | null

Employee first name.

lastName
string | null

Employee last name.

birthdate
string (date-time) | null

Employee date of birth.

payRate
number (double)

Employee pay rate.

paySchedule
string | null

Pay schedule type (e.g. Hourly, Salary).

inactive
boolean

Indicates whether the employee is inactive.

hireDate
string (date-time) | null

Employee hire date. Null when not recorded.

terminationDate
string (date-time) | null

Employee termination date, if applicable.

payrollId
string | null

External payroll system identifier.

primaryLocation
object (R365.Services.Employee.Contract.EmployeeExternal.Apis.Location)
id
string (uuid)

Location identifier.

name
string

Location name.

number
string

Location number.

primaryJob
object | null

Primary job assignment. Null when no primary job is recorded.

id
string (uuid)

Job identifier.

name
string

Job title name.

code
string | null

Job code.

department
string | null

Department name.

otherLocations
Array of object (R365.Services.Employee.Contract.EmployeeExternal.Apis.Location) | null

Additional location assignments.

object
id
string (uuid)

Location identifier.

name
string

Location name.

number
string

Location number.

otherJobs
Array of object (R365.Services.Employee.Contract.EmployeeExternal.Apis.Job) | null

Additional job assignments.

object
id
string (uuid)

Job identifier.

name
string

Job title name.

code
string | null

Job code.

department
string | null

Department name.

nextLink
string | null

Relative URL to retrieve the next page of results. Null when this is the last page.

422

Both ModifiedOnStart and ModifiedOnEnd are absent, or a provided location identifier is not a valid GUID.