Departments

List departments

get

Returns departments in the tenant, paginated. Each entry carries the department's path — an ancestor chain resolved to names and joined by " / " (root ancestor first). Missing ancestors (e.g. after a reparent race) are silently skipped so the path stays a stable string.

Query

• search — optional case-insensitive substring match on the department's own name.

• page / limit — defaults page = 1, limit = 25, max limit = 100.

Authorizations

x-api-keystringRequired

Query parameters

searchstring · max: 100Optional

Case-insensitive substring match on name.

pagenumber · min: 1OptionalDefault: 1

limitnumber · min: 1 · max: 100OptionalDefault: 25

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses

200Success

application/json

429

Returned when the rate limit is exceeded

get/api/v1/public/departments

GET /api/v1/public/departments HTTP/1.1
Host: api-stage.hesh.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "path": "text"
    }
  ],
  "meta": {
    "total": 1,
    "lastPage": 1,
    "currentPage": 1,
    "perPage": 1,
    "prev": 1,
    "next": 1
  }
}