curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/organisational_units \
  --header 'Authorization: Bearer <token>'
{
  "count": 3,
  "results": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "name": "Engineering",
      "total_nr_of_employees": 20,
      "active": true,
      "parent_id": null
    },
    {
      "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
      "name": "IT",
      "total_nr_of_employees": 6,
      "active": true,
      "parent_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a"
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "name": "Finance",
      "total_nr_of_employees": 8,
      "active": true,
      "parent_id": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:
100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 < x < 200
​
offset
integer
default:
0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x > 0
​
parent_id
string

This parameter can be used to only include Organisational Units with the specified parent_id as their direct parent. If parent_id="null", only root Organisational Units are included. If the parameter is not set, all entities will be included.

Response

200
application/json
OK
​
count
integer
required

Total number of Organisational Unit objects stored in the system. If filtered by parent_id, only the matching units are counted.

Required range: x > 0
​
results
object[]
required

Subset of Organisational Unit starting from offset up to offset + limit.

Was this page helpful?