List departments

List all departments in your company.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

company-structure:read

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/departments" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Departments retrieved successfully!",
  "content": {
    "departments": [
      {
        "id": "dept_1",
        "name": "Engineering"
      }
    ]
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Directory → Company chart

/employee/directory?view=chart