WOworkable

/employees/orgchart

Returns org chart nodes for the account. Required scope: r_employees. Supports account tokens.

Each node contains an employee content payload, its parent_id (the manager's SPI key), and direct_reports_count (loaded only at the currently requested level).

When no filters and no employee_id are provided, the response contains top-level employees (those without a manager) together with their first-level direct reports. Provide employee_id to return the direct reports of a specific employee, optionally with include_manager=true to also receive the employee itself and its manager. Providing legal_entity_ids or department_ids returns every employee that matches the filters across the entire chart (no pagination level is applied).

get/employees/orgchart

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/employees/orgchart
  • Auth
    API key in header Authorization

Query parameters

legal_entity_idsstring[]

Filter by one or more legal entity identifiers (UUIDs or numeric ids). Use -1 to match employees without a legal entity.

department_idsstring[]

Filter by one or more department SPI keys.

employee_idstring

SPI key of the employee whose direct reports should be returned. Required when include_manager is true.

include_managerboolean

When true, the response also includes the employee referenced by employee_id and its manager. Requires employee_id.

Response

200

idstring

SPI key of the employee

namestring

Full name of the employee

avatar_urlstring nullable

URL of the employee's avatar image

parent_idstring nullable

SPI key of the employee's manager (the node's parent in the org chart), or null at the top of the tree

direct_reports_countinteger nullable

Number of direct reports for this employee. Present only for nodes whose children are loaded at the requested level.

Example response

[
  {
    "id": "2fce",
    "name": "Jane Boss",
    "direct_reports_count": 3,
    "content": {
      "id": "2fce",
      "name": "Jane Boss",
      "initials": "JB",
      "title": "VP Engineering",
      "state": "published"
    }
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.