---
title: "List Employees"
method: GET
path: "/api/v1/employees"
tags: ["Employees", "Public API"]
---

# List Employees

`GET /api/v1/employees`

Lists all employees in the authenticated caller's company as a cursor-paginated employee directory. Use this to list employees, browse the company directory, fetch the employee roster, or batch-lookup multiple employees by ID. The response is a JSON object with `data` (an array of employee records), `meta.total` (count of all employees matching the filter, not just the current page), `meta.page` (cursor pagination state), and `_links` (`self`, plus `next` / `prev` when more pages exist). Each employee record always includes the default identity and job fields, plus any additional fields requested via `fields`. `employeeId` is returned as a string and is the internal employee ID — see the `employeeId` and `employeeNumber` field documentation in the response schema for the distinction between the internal ID and the editable Employee # value. Field values the caller cannot read are returned as `null`, and the names of those suppressed fields are listed on the record in `_restrictedFields`; if the caller cannot read a field used in `filter` or `sort`, the affected employee is dropped from the result set entirely to avoid leaking presence. IDs for `filter[ids]` come from prior responses of this endpoint. For a single employee with the full set of fields, use `get-employee`. For complex filtering, arbitrary sorting, or tabular reports across many fields, use Get Data from Dataset (v2) (`get-data-from-dataset-v2`). Each record includes a `photoUrl` field with a time-limited signed URL. This is the recommended way for AI connectors to display or link to an employee photo, since fetching raw photo bytes through `get-employee-photo` produces base64 payloads too large for an AI model to consume reliably.

OAuth Scopes: employee, employee:job, employee:name, employee_directory, sensitive_employee:protected_info

## Query parameters

- `filter` GetEmployeesFilterRequestObject — Filter criteria for the employee list endpoint, supplied as `filter[fieldName]=value` query parameters. All filter fields are optional, and multiple fields are combined with AND logic. Three matching strategies are used depending on the field: - **Substring** (case-insensitive `LIKE`) — applied to free-text fields such as names, addresses, social URLs, and free-form labels. - **Equality** — applied to IDs (integer), enumerated string values, booleans (`true`/`false`), numeric values, and ISO 8601 dates (`YYYY-MM-DD`). - **Special** — `ids` accepts a list of internal employee IDs (`filter[ids][]=123&filter[ids][]=124` or `filter[ids]=123,124`). Filtering is **not supported** for the following fields and will return a 422: `bestEmail`, `ein`, `genderIdentity`, `genderIdentityId`, `nationalId`, `nin`, `overtime`, `overtimeRate`, `payRate`, `sin`, `ssn`, `teams`, `userId`, `veteranStatus`, `veteranStatusId`. Any unrecognized filter key will also return a 422.
  - `addressLine1` string — Substring match (case-insensitive).
  - `addressLine2` string — Substring match (case-insensitive).
  - `allergies` string — Substring match (case-insensitive).
  - `birthplace` string — Substring match (case-insensitive).
  - `citizenship` string — Substring match (case-insensitive).
  - `city` string — Substring match (case-insensitive).
  - `compensationChangeReason` string — Substring match (case-insensitive).
  - `compensationComment` string — Substring match (case-insensitive).
  - `country` string — Substring match (case-insensitive).
  - `departmentName` string — Substring match (case-insensitive).
  - `dietaryRestrictions` string — Substring match (case-insensitive).
  - `displayName` string — Substring match (case-insensitive).
  - `divisionName` string — Substring match (case-insensitive).
  - `eeoJobCategory` string — Substring match (case-insensitive).
  - `eligibleForRehire` string — Substring match (case-insensitive).
  - `employeeName` string — Substring match (case-insensitive).
  - `employeeNumber` string — Substring match (case-insensitive).
  - `employmentStatusName` string — Substring match (case-insensitive).
  - `employmentStatusComment` string — Substring match (case-insensitive).
  - `employmentType` string — Substring match (case-insensitive).
  - `ethnicity` string — Substring match (case-insensitive).
  - `facebookUrl` string — Substring match (case-insensitive).
  - `firstNameLastName` string — Substring match (case-insensitive).
  - `firstNameMiddleInitial` string — Substring match (case-insensitive).
  - `flsaCode` string — Substring match (case-insensitive).
  - `homeEmail` string — Substring match (case-insensitive).
  - `homePhone` string — Substring match (case-insensitive).
  - `instagramUrl` string — Substring match (case-insensitive).
  - `jacketSize` string — Substring match (case-insensitive).
  - `linkedinUrl` string — Substring match (case-insensitive).
  - `locationName` string — Substring match (case-insensitive).
  - `maritalStatus` string — Substring match (case-insensitive).
  - `middleInitial` string — Substring match (case-insensitive).
  - `middleName` string — Substring match (case-insensitive).
  - `mobilePhone` string — Substring match (case-insensitive).
  - `nationalInsuranceCategory` string — Substring match (case-insensitive).
  - `nationality` string — Substring match (case-insensitive).
  - `nickName` string — Substring match (case-insensitive).
  - `noticePeriod` string — Substring match (case-insensitive).
  - `paySchedule` string — Substring match (case-insensitive).
  - `pinterestUrl` string — Substring match (case-insensitive).
  - `preferredNameLastName` string — Substring match (case-insensitive).
  - `pronouns` string — Substring match (case-insensitive).
  - `reportsToName` string — Substring match (case-insensitive).
  - `secondaryLanguage` string — Substring match (case-insensitive).
  - `shirtSize` string — Substring match (case-insensitive).
  - `skypeUsername` string — Substring match (case-insensitive).
  - `state` string — Substring match (case-insensitive).
  - `terminationReason` string — Substring match (case-insensitive).
  - `terminationRegrettable` string — Substring match (case-insensitive).
  - `terminationType` string — Substring match (case-insensitive).
  - `tShirtSize` string — Substring match (case-insensitive).
  - `twitterUrl` string — Substring match (case-insensitive).
  - `vaccinationStatus` string — Substring match (case-insensitive).
  - `vaccineReceived` string — Substring match (case-insensitive).
  - `workEmail` string — Substring match (case-insensitive).
  - `workPhone` string — Substring match (case-insensitive).
  - `workPhoneExtension` string — Substring match (case-insensitive).
  - `zipcode` string — Substring match (case-insensitive).
  - `gender` 'Male' | 'Female' | 'Non-Binary' — Exact match.
  - `paidPer` 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year' | 'PayPeriod' | 'Piece' — Exact match.
  - `payType` 'Hourly' | 'Salary' | 'Commission' — Exact match.
  - `citizenshipId` integer — Exact match against an integer ID.
  - `compensationChangeReasonId` integer — Exact match against an integer ID.
  - `countryId` integer — Exact match against an integer ID.
  - `departmentId` integer — Exact match against an integer ID.
  - `divisionId` integer — Exact match against an integer ID.
  - `eeoJobCategoryId` integer — Exact match against an integer ID.
  - `eligibleForRehireId` integer — Exact match against an integer ID.
  - `employmentStatusId` integer — Exact match against an integer ID.
  - `employmentTypeId` integer — Exact match against an integer ID.
  - `ethnicityId` integer — Exact match against an integer ID.
  - `flsaCodeId` integer — Exact match against an integer ID.
  - `jacketSizeId` integer — Exact match against an integer ID.
  - `jobTitleId` integer — Exact match against an integer ID.
  - `locationId` integer — Exact match against an integer ID.
  - `nationalInsuranceCategoryId` integer — Exact match against an integer ID.
  - `nationalityId` integer — Exact match against an integer ID.
  - `noticePeriodId` integer — Exact match against an integer ID.
  - `payScheduleId` integer — Exact match against an integer ID.
  - `pronounsId` integer — Exact match against an integer ID.
  - `reportsToId` integer — Exact match against the internal employee ID of the employee's manager.
  - `shirtSizeId` integer — Exact match against an integer ID.
  - `stateId` integer — Exact match against an integer ID.
  - `taxTypeId` integer — Exact match against an integer ID.
  - `terminationReasonId` integer — Exact match against an integer ID.
  - `terminationRegrettableId` integer — Exact match against an integer ID.
  - `terminationTypeId` integer — Exact match against an integer ID.
  - `tShirtSizeId` integer — Exact match against an integer ID.
  - `vaccinationStatusId` integer — Exact match against an integer ID.
  - `vaccineReceivedId` integer — Exact match against an integer ID.
  - `isManager` boolean — Exact match (true/false).
  - `proofOfVaccination` boolean — Exact match (true/false).
  - `age` number — Exact numeric match.
  - `tenure` number — Exact numeric match.
  - `hoursPerPayCycle` number — Exact numeric match.
  - `birthDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `compensationEffectiveDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `compensationEndDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `contractEndDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `employmentStatusEffectiveDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `finalDoseAdministrationDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `finalPayDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `hireDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `jobInformationEffectiveDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `originalHireDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `probationEndDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `terminationDate` string, date — Exact match against an ISO 8601 date (YYYY-MM-DD).
  - `firstName` string — This will match any employees whose first name contains this string (case insensitive)
  - `lastName` string — This will match any employees whose last name contains this string (case insensitive)
  - `jobTitleName` string — This will match any employees whose current job title descriptor contains this string (case insensitive)
  - `status` 'active' | 'inactive' — Employee status
  - `ids` integer[] — List of internal employee IDs for batch fetch. Documented form: repeated keys (`filter[ids][]=123&filter[ids][]=124`). For backward compatibility, the endpoint also accepts a single comma-separated string (`filter[ids]=123,124`).
- `sort` string
- `fields` EmployeeOptionalField[]
- `page` EmployeeCursorPaginationQueryObject
  - `before` string — Cursor pointing to the start of the previous page. Use the `prevCursor` value from the last response to paginate backward.
  - `after` string — Cursor pointing to the start of the next page. Use the `nextCursor` value from the last response to paginate forward.
  - `limit` integer — Maximum number of items to return. This can be at most 2500.

## Response `200`

Paginated list of employees.

- GetEmployeesResponseObject — Complete response object for employee list API containing employee data, metadata, and navigation links
  - `data` GetEmployeesEmployeeResponse[], required — Typed collection of employee response objects
    - `employeeId` string, required — The internal employee ID — the canonical, immutable identifier for this employee across all employee endpoints. Equivalent to `id` on `get-employee` and `eeid` on the `employee` dataset. Use this value (not `employeeNumber`) for employee ID inputs such as `{id}` path parameters or `filter[ids]`.
    - `firstName` string, nullable, required — Employee's first name
    - `lastName` string, nullable, required — Employee's last name
    - `preferredName` string, nullable, required — Employee's preferred name
    - `photoUrl` string, nullable, required — URL to employee's profile photo
    - `jobTitleName` string, nullable, required — Employee's current job title
    - `status` string, nullable, required — Employee's current status (Active or Inactive).
    - `_restrictedFields` string[], required — Array of field names that are restricted due to permission checks
    - `addressLine1` string, nullable — Employee's address line 1. Only included when requested via the `fields` parameter.
    - `addressLine2` string, nullable — Employee's address line 2. Only included when requested via the `fields` parameter.
    - `age` string, nullable — Employee's age. Only included when requested via the `fields` parameter.
    - `allergies` string, nullable — Employee's allergies. Only included when requested via the `fields` parameter.
    - `bestEmail` string, nullable — Employee's best email address. Only included when requested via the `fields` parameter.
    - `birthDate` string, nullable — Employee's birth date. Only included when requested via the `fields` parameter.
    - `birthplace` string, nullable — Employee's birthplace. Only included when requested via the `fields` parameter.
    - `citizenship` string, nullable — Employee's citizenship. Only included when requested via the `fields` parameter.
    - `citizenshipId` string, nullable — Employee's citizenship ID. Only included when requested via the `fields` parameter.
    - `city` string, nullable — Employee's city. Only included when requested via the `fields` parameter.
    - `compensationChangeReason` string, nullable — Employee's compensation change reason. Only included when requested via the `fields` parameter.
    - `compensationChangeReasonId` string, nullable — Employee's compensation change reason ID. Only included when requested via the `fields` parameter.
    - `compensationComment` string, nullable — Employee's compensation comment. Only included when requested via the `fields` parameter.
    - `compensationEffectiveDate` string, nullable — Employee's compensation effective date. Only included when requested via the `fields` parameter.
    - `compensationEndDate` string, nullable — Employee's compensation end date. Only included when requested via the `fields` parameter.
    - `contractEndDate` string, nullable — Employee's contract end date. Only included when requested via the `fields` parameter.
    - `country` string, nullable — Employee's country. Only included when requested via the `fields` parameter.
    - `countryId` string, nullable — Employee's country ID. Only included when requested via the `fields` parameter.
    - `departmentId` string, nullable — Employee's department ID. Only included when requested via the `fields` parameter.
    - `departmentName` string, nullable — Employee's department name. Only included when requested via the `fields` parameter.
    - `dietaryRestrictions` string, nullable — Employee's dietary restrictions. Only included when requested via the `fields` parameter.
    - `displayName` string, nullable — Employee's name displayed in the company configured format. Only included when requested via the `fields` parameter.
    - `divisionId` string, nullable — Employee's division ID. Only included when requested via the `fields` parameter.
    - `divisionName` string, nullable — Employee's division name. Only included when requested via the `fields` parameter.
    - `eeoJobCategory` string, nullable — Employee's EEO job category. Only included when requested via the `fields` parameter.
    - `eeoJobCategoryId` string, nullable — Employee's EEO job category ID. Only included when requested via the `fields` parameter.
    - `ein` string, nullable — Employee's EIN. Only included when requested via the `fields` parameter.
    - `eligibleForRehire` string, nullable — Employee's eligible-for-rehire flag. Only included when requested via the `fields` parameter.
    - `eligibleForRehireId` string, nullable — Employee's eligible-for-rehire ID. Only included when requested via the `fields` parameter.
    - `employeeName` string, nullable — Employee's name (last, first). Only included when requested via the `fields` parameter.
    - `employeeNumber` string, nullable — The employee's editable Employee # value (the HR-visible display field on the employee profile). This is not the internal employee ID used by API inputs such as `filter[ids]` and `{id}` path parameters; those inputs expect `employeeId` on this endpoint, `id` on `get-employee`, or `eeid` on the `employee` dataset. Passing `employeeNumber` there may fail with `404` or resolve to a different employee if its value matches another employee's internal employee ID. Only included when requested via the `fields` parameter.
    - `employmentStatusComment` string, nullable — Employee's employment status comment. Only included when requested via the `fields` parameter.
    - `employmentStatusEffectiveDate` string, nullable — Employee's employment status effective date. Only included when requested via the `fields` parameter.
    - `employmentStatusId` string, nullable — Employee's employment status id. Only included when requested via the `fields` parameter.
    - `employmentStatusName` string, nullable — Employee's employment status name. Only included when requested via the `fields` parameter.
    - `employmentType` string, nullable — Employee's employment type. Only included when requested via the `fields` parameter.
    - `employmentTypeId` string, nullable — Employee's employment type ID. Only included when requested via the `fields` parameter.
    - `ethnicity` string, nullable — Employee's ethnicity. Only included when requested via the `fields` parameter.
    - `ethnicityId` string, nullable — Employee's ethnicity ID. Only included when requested via the `fields` parameter.
    - `facebookUrl` string, nullable — Employee's Facebook profile URL. Only included when requested via the `fields` parameter.
    - `finalDoseAdministrationDate` string, nullable — Employee's final COVID dose administration date. Only included when requested via the `fields` parameter.
    - `finalPayDate` string, nullable — Employee's final pay date. Only included when requested via the `fields` parameter.
    - `firstNameLastName` string, nullable — Employee's first and last name. Only included when requested via the `fields` parameter.
    - `firstNameMiddleInitial` string, nullable — Employee's first name and middle initial. Only included when requested via the `fields` parameter.
    - `flsaCode` string, nullable — Employee's FLSA code. Only included when requested via the `fields` parameter.
    - `flsaCodeId` string, nullable — Employee's FLSA code ID. Only included when requested via the `fields` parameter.
    - `gender` string, nullable — Employee's gender. Only included when requested via the `fields` parameter.
    - `genderIdentity` string, nullable — Employee's gender identity. Only included when requested via the `fields` parameter.
    - `genderIdentityId` integer[] — Employee's gender identity ID. Only included when requested via the `fields` parameter.
    - `hireDate` string, nullable — Employee's hire date. Only included when requested via the `fields` parameter.
    - `homeEmail` string, nullable — Employee's home email address. Only included when requested via the `fields` parameter.
    - `homePhone` string, nullable — Employee's home phone number. Only included when requested via the `fields` parameter.
    - `hoursPerPayCycle` string, nullable — Employee's hours per pay cycle. Only included when requested via the `fields` parameter.
    - `instagramUrl` string, nullable — Employee's Instagram profile URL. Only included when requested via the `fields` parameter.
    - `isManager` boolean, nullable — Whether the employee is a manager. Only included when requested via the `fields` parameter.
    - `jacketSize` string, nullable — Employee's jacket size. Only included when requested via the `fields` parameter.
    - `jacketSizeId` string, nullable — Employee's jacket size ID. Only included when requested via the `fields` parameter.
    - `jobInformationEffectiveDate` string, nullable — Employee's job information effective date. Only included when requested via the `fields` parameter.
    - `jobTitleId` string, nullable — Employee's job title id. Only included when requested via the `fields` parameter.
    - `linkedinUrl` string, nullable — Employee's LinkedIn profile URL. Only included when requested via the `fields` parameter.
    - `locationId` string, nullable — Employee's location ID. Only included when requested via the `fields` parameter.
    - `locationName` string, nullable — Employee's location name. Only included when requested via the `fields` parameter.
    - `maritalStatus` string, nullable — Employee's marital status. Only included when requested via the `fields` parameter.
    - `middleInitial` string, nullable — Employee's middle initial. Only included when requested via the `fields` parameter.
    - `middleName` string, nullable — Employee's middle name. Only included when requested via the `fields` parameter.
    - `mobilePhone` string, nullable — Employee's mobile phone number. Only included when requested via the `fields` parameter.
    - `nationalId` string, nullable — Employee's national ID. Only included when requested via the `fields` parameter.
    - `nationalInsuranceCategory` string, nullable — Employee's national insurance category. Only included when requested via the `fields` parameter.
    - `nationalInsuranceCategoryId` string, nullable — Employee's national insurance category ID. Only included when requested via the `fields` parameter.
    - `nationality` string, nullable — Employee's nationality. Only included when requested via the `fields` parameter.
    - `nationalityId` string, nullable — Employee's nationality ID. Only included when requested via the `fields` parameter.
    - `nickName` string, nullable — Employee's preferred name. If preferred name is not set then employee's first name is returned. Only included when requested via the `fields` parameter.
    - `nin` string, nullable — Employee's NIN. Only included when requested via the `fields` parameter.
    - `noticePeriod` string, nullable — Employee's notice period. Only included when requested via the `fields` parameter.
    - `noticePeriodId` string, nullable — Employee's notice period ID. Only included when requested via the `fields` parameter.
    - `originalHireDate` string, nullable — Employee's original hire date. Only included when requested via the `fields` parameter.
    - `overtime` string, nullable — Employee's overtime status. Only included when requested via the `fields` parameter.
    - `overtimeRate` object — Employee's overtime rate. Only included when requested via the `fields` parameter.
      - `amount` string
      - `currency` string
    - `paidPer` string, nullable — How the employee is paid (e.g., hour, year). Only included when requested via the `fields` parameter.
    - `payRate` object — Employee's pay rate. Only included when requested via the `fields` parameter.
      - `amount` string
      - `currency` string
    - `paySchedule` string, nullable — Employee's pay schedule. Only included when requested via the `fields` parameter.
    - `payScheduleId` string, nullable — Employee's pay schedule ID. Only included when requested via the `fields` parameter.
    - `payType` string, nullable — Employee's pay type. Only included when requested via the `fields` parameter.
    - `pinterestUrl` string, nullable — Employee's Pinterest profile URL. Only included when requested via the `fields` parameter.
    - `preferredNameLastName` string, nullable — Employee's preferred name and last name. Only included when requested via the `fields` parameter.
    - `probationEndDate` string, nullable — Employee's probation end date. Only included when requested via the `fields` parameter.
    - `pronouns` string, nullable — Employee's pronouns. Only included when requested via the `fields` parameter.
    - `pronounsId` string, nullable — Employee's pronouns ID. Only included when requested via the `fields` parameter.
    - `proofOfVaccination` boolean, nullable — Whether proof of vaccination has been provided. Only included when requested via the `fields` parameter.
    - `reportsToId` string, nullable — The internal employee ID of the employee's manager. Only included when requested via the `fields` parameter.
    - `reportsToName` string, nullable — Employee's manager's name. Only included when requested via the `fields` parameter.
    - `secondaryLanguage` string, nullable — Employee's secondary language. Only included when requested via the `fields` parameter.
    - `shirtSize` string, nullable — Employee's shirt size. Only included when requested via the `fields` parameter.
    - `shirtSizeId` string, nullable — Employee's shirt size ID. Only included when requested via the `fields` parameter.
    - `sin` string, nullable — Employee's SIN. Only included when requested via the `fields` parameter.
    - `skypeUsername` string, nullable — Employee's Skype username. Only included when requested via the `fields` parameter.
    - `ssn` string, nullable — Employee's SSN. Only included when requested via the `fields` parameter.
    - `state` string, nullable — Employee's state. Only included when requested via the `fields` parameter.
    - `stateId` string, nullable — Employee's state ID. Only included when requested via the `fields` parameter.
    - `taxTypeId` string, nullable — Employee's tax type ID. Only included when requested via the `fields` parameter.
    - `teams` object[] — Employee's teams. Only included when requested via the `fields` parameter.
      - `id` integer
      - `label` string
    - `tenure` string, nullable — Employee's tenure. Only included when requested via the `fields` parameter.
    - `terminationDate` string, nullable — Employee's termination date. Only included when requested via the `fields` parameter.
    - `terminationReason` string, nullable — Employee's termination reason. Only included when requested via the `fields` parameter.
    - `terminationReasonId` string, nullable — Employee's termination reason ID. Only included when requested via the `fields` parameter.
    - `terminationRegrettable` string, nullable — Whether the termination was regrettable. Only included when requested via the `fields` parameter.
    - `terminationRegrettableId` string, nullable — Termination regrettable ID. Only included when requested via the `fields` parameter.
    - `terminationType` string, nullable — Employee's termination type. Only included when requested via the `fields` parameter.
    - `terminationTypeId` string, nullable — Employee's termination type ID. Only included when requested via the `fields` parameter.
    - `tShirtSize` string, nullable — Employee's t-shirt size. Only included when requested via the `fields` parameter.
    - `tShirtSizeId` string, nullable — Employee's t-shirt size ID. Only included when requested via the `fields` parameter.
    - `twitterUrl` string, nullable — Employee's Twitter/X profile URL. Only included when requested via the `fields` parameter.
    - `userId` string, nullable — Employee's user ID. Only included when requested via the `fields` parameter.
    - `vaccinationStatus` string, nullable — Employee's COVID vaccination status. Only included when requested via the `fields` parameter.
    - `vaccinationStatusId` string, nullable — Employee's COVID vaccination status ID. Only included when requested via the `fields` parameter.
    - `vaccineReceived` string, nullable — Employee's COVID vaccine received. Only included when requested via the `fields` parameter.
    - `vaccineReceivedId` string, nullable — Employee's COVID vaccine received ID. Only included when requested via the `fields` parameter.
    - `veteranStatus` string, nullable — Employee's veteran status. Only included when requested via the `fields` parameter.
    - `veteranStatusId` integer[] — Employee's veteran status ID. Only included when requested via the `fields` parameter.
    - `workEmail` string, nullable — Employee's work email address. Only included when requested via the `fields` parameter.
    - `workPhone` string, nullable — Employee's work phone number. Only included when requested via the `fields` parameter.
    - `workPhoneExtension` string, nullable — Employee's work phone extension. Only included when requested via the `fields` parameter.
    - `zipcode` string, nullable — Employee's zip code. Only included when requested via the `fields` parameter.
  - `meta` CursorPagedResponseMetadata, required — Metadata information for employee list responses including total count and pagination details
    - `total` integer, required — Total number of employees matching the filter criteria
    - `page` CursorPagesResponse, required — Pagination information for employee list responses including limit and cursor-based navigation
      - `limit` integer, nullable, required — Maximum number of items per page
      - `nextCursor` string, nullable, required — Cursor for the next page of results, null if no more pages. This should be used with the after pagination parameter.
      - `prevCursor` string, nullable, required — Cursor for the previous page of results, null if on first page. This should be used with the before pagination parameter.
  - `_links` object, required — Navigation links for API pagination
    - `self` object — Link to current page
      - `href` string — URL of the current page
    - `next` object — Link to next page
      - `href` string — URL of the next page
    - `prev` object — Link to previous page
      - `href` string — URL of the previous page

## Other responses

- `400` — Invalid request parameters. The `error.code` is `BadRequest` for filter, sort, or field validation failures (for example an unknown sort field, or `filter[status]` outside `active` / `inactive`) and `BadPage` when the `page` cursor is malformed, the wrong cursor direction is supplied, or the boundary employee changed between calls (for example, was deleted or no longer matches the filter).
- `401` — Unauthorized.
- `429` — Too many requests.
- `500` — Internal server error.

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)
