Get Employee Directory

Returns the company employee directory, including a fieldset definition and an array of employee records. Only returns employees with an employee status of 'Active'. By default only current employees are returned; pass onlyCurrent=false to include employees where hire date or employment status are in the future. If the caller has org-chart access but not full directory access, a reduced fieldset is returned. Returns 403 if neither directory nor org-chart sharing is enabled for the company. Returns 404 if the directory is empty. The response format is controlled by the Accept header.

Query Params
boolean
Defaults to true

When true (the default), only current employees are returned. Set to false to future employees that have a hire date or employment status effective date in the future.

Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

The company directory is not shared company-wide and the caller does not have org-chart access.

404

The directory is empty.

500

An internal server error occurred while generating the directory report.

Language
Credentials
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json