CHchrt
/operations/departments

List

Changed on

Lists department configurations for the caller's organization with filtering, sorting, pagination, and Atlas Search. | authz: min_org_role=operator | () -> (DepartmentListRes)

get/operations/departments/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/operations/departments/list/v1
  • Auth
    HTTP bearer

Query parameters

sort_by'created_at' | 'department_type'

Field to sort by

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc)

searchstring nullable

Search name and short_id using Atlas Search

pageinteger
page_sizeinteger
filter_department_idsstring[] nullable

Filter by selected department ids

filter_department_typeDepartmentTypeEnum[] nullable

Filter by department type(s)

Response

Successful Response

total_countinteger required

Changes