Get Employees Directory

Returns the company's published employee directory: a fieldset definition plus an array of employee records whose keys match the field ids. Coverage is intentionally incomplete — companies can hide individual employees (commonly contractors) from the directory, and those employees are silently absent from the response with no indicator that they exist. The fieldset is also fixed by company directory configuration; callers cannot request additional fields. Use this endpoint only when you specifically want the company's curated directory subset (for example, an org-style listing that respects the company's directory settings). For complete or general-purpose employee listings, batch lookups by ID, or filtering by name/status, use List Employees (list-employees) instead. For tabular reporting, custom field selection, or analytical queries across many employees, use Get Data from Dataset (v2) (get-data-from-dataset-v2) instead. Response format follows the Accept header: application/json returns a JSON object with fields and employees arrays; application/xml (the default when Accept is missing or any non-JSON value) returns a <directory> document with <fieldset> and <employees> children. Employee id values are internal employee IDs returned as strings in both formats. The response shape varies by caller permission and per-company configuration: when neither company-wide directory sharing nor org-chart sharing is enabled the endpoint returns 403; when only org-chart sharing is enabled the response uses a reduced fieldset (limited to the fields exposed by the org chart); when the resulting directory has no employees the endpoint returns 404 rather than an empty list.

OAuth Scopes: employee_directory