Records

Count records

A real SQL COUNT — always the exact total, never a partial or capped number, so it's safe to render as a canonical figure (e.g. a dashboard summary tile). Plain baseId scoping is always cheap. Adding viewId and/or filters is exact too — provably-exact conditions (e.g. text equals/contains, not_empty/is_empty, checkbox is_true/is_false) stay a cheap SQL COUNT; everything else falls back to evaluating every matching row server-side, which is exact but not free on a large Base. Both viewId and filters require baseId.

get/api/v1/records/count

Request

  • Base URL: https://api-docs.busabase.com
  • URL: https://api-docs.busabase.com/api/v1/records/count
  • Auth: none declared

Query parameters

baseIdstring

Restrict to one Base. Omitting it counts every record in the space. Required as soon as viewId, filters or valueFilters is given — a field slug only means something within one Base.

viewIdstring

Count only what this saved View would display. Its filters apply; its sort is ignored, since a count has no order. Requires baseId.

fieldSlugstring required
fieldTypestring
operator'contains' | 'equals' | 'not_empty' | 'is_empty' | 'is_true' | 'is_false' required
valueunknown

Response

Total active records matching the scope: the whole space, one Base, a saved View, an ad-hoc filter set, or a combination.

totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.