Skip to main content

List Cost Categories (Paginated)

GET 
/api/cost-categories/list

Paginated, server-side-filtered list of cost categories. Supports search (name / id / keyword aliases), active/system/selectable filters, and sorting, returning a standard paginated envelope. Each item includes usage counts and, when set, the embedded default nominal code.

Use this endpoint when building a browsable, filterable table of cost categories. For a full unpaginated list (e.g. to populate a dropdown) use GET /api/cost-categories instead.

Query parameters:

  • filter[search] — search term (partial match on name; scope with search_columns)
  • search_columns — restrict search to: name, id, keyword
  • filter[is_active] — 1 active / 0 archived
  • filter[is_system] — 1 system / 0 user-defined
  • filter[selectable] — 1 to exclude system categories
  • sort — id, name, is_system, is_active, created_at, updated_at (prefix - for DESC)
  • page, per_page — pagination (per_page default 10)

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type