Tables

Query table rows

The one "rows where …" question. A filter tree (and / or / not over clauses that name a field by key, or one hop through a relation as relation.field), search, sort, a saved viewId whose filter is merged in, a row page, groups with per-group calculations, and calculations over the whole filtered set — answered together, so a total beside a page of rows is a total of those rows. Pass rows: false to skip the page. A question the schema cannot answer is a 400 QUERY_REFUSED whose details[] name each offending path; a view that does not exist, or that belongs to someone else, is a 404 VIEW_NOT_FOUND.

post/v1/tables/{tableId}/rows/query

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/tables/{tableId}/rows/query
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

tableIdstring required

Table ID

Request body

searchstring
viewIdstring
fieldsstring[]
deletedboolean
calculationsobject

Response

Rows, groups and calculations over one filtered set

successtrue required

Changes

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