v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB

Departments

List departments

This endpoint lists departments of a company.

post/v3/companies/{companyId}/departments/list

Request body

searchTextstring

Search string entered by the user

Example request

{
  "searchText": "Engineering",
  "filters": [
    {
      "externalIds": [
        "department-external-id"
      ],
      "departmentIds": [
        "731ccbca-0415-6fe1-d235-c324dfbe7423"
      ]
    }
  ]
}

Response

Example response

{
  "departments": [
    {
      "id": "731ccbca-0415-6fe1-d235-c324dfbe7423",
      "name": "Accounting"
    }
  ]
}