Skip to main content
GET
/
companies
/
{company_id}
/
departments
curl -X GET "https://api.companyflow.com/companies/{company_id}/departments?page=1&page_size=10&status=active" \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "company_id": "987fcdeb-51a2-43f7-9c5d-123456789abc",
        "name": "Engineering",
        "code": "ENG",
        "description": "Software engineering and development",
        "parent_department_id": null,
        "cost_center": "CC-100",
        "status": "active",
        "created_at": "2026-03-03T10:00:00Z",
        "updated_at": "2026-03-03T10:00:00Z"
      },
      {
        "id": "234e5678-e89b-12d3-a456-426614174001",
        "company_id": "987fcdeb-51a2-43f7-9c5d-123456789abc",
        "name": "Human Resources",
        "code": "HR",
        "description": "Human resources management",
        "parent_department_id": null,
        "cost_center": "CC-200",
        "status": "active",
        "created_at": "2026-03-03T11:00:00Z",
        "updated_at": "2026-03-03T11:00:00Z"
      }
    ],
    "total": 2,
    "page": 1,
    "page_size": 10,
    "total_pages": 1
  }
}

Authentication

This endpoint requires authentication with a Bearer token. Only users with Super Admin or HR Manager roles can list departments.
company_id
string
required
The unique identifier of the company

Query Parameters

page
integer
default:"1"
Page number for pagination
page_size
integer
default:"10"
Number of items per page
status
string
Filter by department status. Must be one of: active, inactive
Search departments by name or code

Response

success
boolean
Indicates if the request was successful
data
object
Paginated department list
curl -X GET "https://api.companyflow.com/companies/{company_id}/departments?page=1&page_size=10&status=active" \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "company_id": "987fcdeb-51a2-43f7-9c5d-123456789abc",
        "name": "Engineering",
        "code": "ENG",
        "description": "Software engineering and development",
        "parent_department_id": null,
        "cost_center": "CC-100",
        "status": "active",
        "created_at": "2026-03-03T10:00:00Z",
        "updated_at": "2026-03-03T10:00:00Z"
      },
      {
        "id": "234e5678-e89b-12d3-a456-426614174001",
        "company_id": "987fcdeb-51a2-43f7-9c5d-123456789abc",
        "name": "Human Resources",
        "code": "HR",
        "description": "Human resources management",
        "parent_department_id": null,
        "cost_center": "CC-200",
        "status": "active",
        "created_at": "2026-03-03T11:00:00Z",
        "updated_at": "2026-03-03T11:00:00Z"
      }
    ],
    "total": 2,
    "page": 1,
    "page_size": 10,
    "total_pages": 1
  }
}

Build docs developers (and LLMs) love