Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Departments

List Company Departments

Lists all departments for the authorized company specified in the request.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View departments (company_department:read)Manage departments (company_department:write)
get/v1/company-departments

Query parameters

company_idstring required

Company ID

paginateboolean

Paginate option. Default: true. When true, paginates response; otherwise, does not.

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

current_pageinteger required
total_countinteger required
total_pagesinteger required

Example response

{
  "current_page": 1,
  "data": {
    "company_departments": [
      {
        "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
        "id": "89c4fbb2-cd1f-4334-8e4b-280f8795bbd8",
        "name": "Marketing"
      }
    ]
  },
  "total_count": 1,
  "total_pages": 1
}