Records

List a numbered record page

get/api/v1/records/page

Request

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

Query parameters

baseIdstring required

Required here, unlike records.list where omitting it spans the whole space.

viewIdstring

Show only what this saved View would: its filters and its sort.

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

Inclusive lower bound, ISO 8601 UTC instant.

ltstring required

EXCLUSIVE upper bound, ISO 8601 UTC instant.

fieldSlugstring required
fieldTypestring
direction'asc' | 'desc'
pageinteger

1-indexed, not 0-indexed.

pageSizeinteger

Records per page. Capped at 100.

Response

A random-access page of active records. When viewId is supplied, the saved view is authoritatively filtered and sorted before total and page slicing are calculated. An explicit sort (same shape as records.list's) replaces the View's sort, so page N of a number- or date-sorted list is one request. dateRange additionally scopes to a [gte, lt) UTC instant window on a date/created_time/updated_time field.

totalinteger required
totalPagesinteger required
pageinteger required
pageSizeinteger required

Changes

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