curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/organisational_units/export \
  --header 'Authorization: Bearer <token>'
{
  "organisational_structure": [
    {
      "external_id": "c3903505-eb84-42dc-a79f-5d8b1fe897b7",
      "name": "Engineering",
      "total_nr_of_employees": 16,
      "low_data_availability": 123,
      "children": [
        {
          "external_id": "d3903505-eb84-42dc-a79f-5d8b1fe897b7",
          "name": "Frontend Engineering",
          "total_nr_of_employees": 9,
          "low_data_availability": 123,
          "children": [
            {}
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
skill_id
string

The unique ID of a Skill, consisting of alphanumeric characters and hyphens. Setting this parameter will include only Organisational Units with Employees that have this Skill in their Skill Profile, and per Organisational Unit only count the number of Employees with this Skill.

Required string length: 1 - 100
​
include
enum<string>[]

When set to low_data_availability_flag, the response will include information about the total number of Employees with low data availability within each Organisational Unit. For Employees, this field is equal to 1 or 0 depending on whether the Employee has low data availability.

Available options:
low_data_availability_flag

Response

200
application/json
OK
​
organisational_structure
object[]
required

A list of Organisational Units that do not have a parent.

Was this page helpful?

Get Taxonomy exportOverview