> ## 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.

# 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**

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 |

## OpenAPI

````json GET /public/v1/labor/employees
{
  "openapi": "3.0.1",
  "info": {
    "title": "R365 Public API",
    "contact": {
      "name": "R365 Services Team",
      "email": "r365@restaurant365.com"
    },
    "version": "1.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/public/v1/labor/employees": {
      "get": {
        "tags": [
          "labor"
        ],
        "summary": "Employees",
        "description": "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.\n\n**Security**\n\nThe requesting user must have the following permission to retrieve employees:\n\n- Labor → Employees → View Employees\n\n_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.\n\n| Field | Additional permission required |\n| --- | --- |\n| `posEmployeeId` | Labor → Employees → POS Employees → View POS Employees |\n| `birthdate` | Labor → Employees → Basic Info → PII → View PII |\n| `paySchedule` | Labor → Employees → Employment → Pay Type → View Pay Type |\n| `payrollId` | Labor → Employees → Employment → Payroll ID → View Payroll ID |\n| `payRate` | Labor → Employees → Employment → Hourly Pay Rates → View Hourly Pay Rates **or** Labor → Employees → Employment → Salary Pay Rates → View Salary Pay Rates |\n| `primaryJob`, `otherJobs` | Labor → Employees → Employment → Hourly Job Info → View Hourly Job Info **or** Labor → Employees → Employment → Salary Job Info → View Salary Job Info |",
        "parameters": [
          {
            "$ref": "#/components/parameters/TenantId"
          },
          {
            "name": "ModifiedOnStart",
            "in": "query",
            "description": "Start of the modified-on date range (inclusive). If provided alone the query is scoped to that single day",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "ModifiedOnEnd",
            "in": "query",
            "description": "End of the modified-on date range (inclusive). If provided alone the query is scoped to that single day",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "locations",
            "in": "query",
            "description": "Comma-separated list of R365 Location GUIDs to filter results. If omitted, all accessible locations are included",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "legalEntities",
            "in": "query",
            "description": "Comma-separated list of R365 Legal Entity GUIDs to filter results. If omitted, all accessible legal entities are included",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 250,
              "default": 250
            },
            "description": "Maximum number of top-level objects to return in one page."
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "Opaque token from NextLink of a prior response. Omit on the first request; pass verbatim to fetch the next page",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged response containing employees for the requested page and a link to the next page when available.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmployeeExternalPagedResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range."
          },
          "401": {
            "description": "Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant."
          },
          "403": {
            "description": "Forbidden — the caller lacks the permission required for this operation."
          },
          "404": {
            "description": "Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired."
          },
          "409": {
            "description": "Conflict — the request conflicts with the current state of the resource and cannot be applied."
          },
          "422": {
            "description": "Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid."
          },
          "429": {
            "description": "Too Many Requests — the caller has exceeded the rate limit; retry after a short delay."
          },
          "500": {
            "description": "Internal Server Error — an unexpected error occurred while processing the request."
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "TenantId": {
        "name": "x-r365-context-tenant-id",
        "in": "header",
        "required": true,
        "description": "Identifies the R365 tenant the request applies to. Required on every request.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "EmployeeExternalPagedResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalEmployeeResponse"
            },
            "description": "Employees for the current page."
          },
          "nextLink": {
            "type": "string",
            "description": "Relative URL to retrieve the next page of results. Null when this is the last page.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ExternalEmployeeResponse": {
        "type": "object",
        "properties": {
          "employeeId": {
            "type": "string",
            "description": "R365 employee identifier.",
            "format": "uuid"
          },
          "posEmployeeId": {
            "type": "string",
            "description": "POS system employee identifier.",
            "nullable": true
          },
          "firstName": {
            "type": "string",
            "description": "Employee first name.",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "description": "Employee last name.",
            "nullable": true
          },
          "birthdate": {
            "type": "string",
            "description": "Employee date of birth.",
            "format": "date-time",
            "nullable": true
          },
          "payRate": {
            "type": "number",
            "description": "Employee pay rate.",
            "format": "double"
          },
          "paySchedule": {
            "type": "string",
            "description": "Pay schedule type (e.g. Hourly, Salary).",
            "nullable": true
          },
          "inactive": {
            "type": "boolean",
            "description": "Indicates whether the employee is inactive."
          },
          "hireDate": {
            "type": "string",
            "description": "Employee hire date. Null when not recorded.",
            "format": "date-time",
            "nullable": true
          },
          "terminationDate": {
            "type": "string",
            "description": "Employee termination date, if applicable.",
            "format": "date-time",
            "nullable": true
          },
          "payrollId": {
            "type": "string",
            "description": "External payroll system identifier.",
            "nullable": true
          },
          "primaryLocation": {
            "$ref": "#/components/schemas/ApisLocation"
          },
          "primaryJob": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Job"
              }
            ],
            "description": "Primary job assignment. Null when no primary job is recorded.",
            "nullable": true
          },
          "otherLocations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApisLocation"
            },
            "description": "Additional location assignments.",
            "nullable": true
          },
          "otherJobs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Job"
            },
            "description": "Additional job assignments.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ApisLocation": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Location identifier.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Location name."
          },
          "number": {
            "type": "string",
            "description": "Location number."
          }
        },
        "additionalProperties": false
      },
      "Job": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Job identifier.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Job title name."
          },
          "code": {
            "type": "string",
            "description": "Job code.",
            "nullable": true
          },
          "department": {
            "type": "string",
            "description": "Department name.",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "Bearer"
      }
    }
  }
}
````