Query a database

POST/v1/databases/{databaseId}/query

Returns one window of a view's rows (filtered, sorted, grouped), with the total and group counts. Pass viewId for a saved view, or view for an ad-hoc one (both: view overrides). uniqueId values are numbers (shown as prefix-number, e.g. LYD-12); filters take 12 or "LYD-12".

docs:readRead-only

Request

curl -X POST "https://api.lydie.co/v1/databases/01JCQ3V5MZ8G4ZK2X7T9R6N1PB/query" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Path parameters

databaseIdULIDrequired

Body

viewIdULID
viewobject
Show 2 fieldsHide fields
- typestring
  One oftableboardlistcalendargallery
  Default "table"
- configViewConfigPatchInput
  Default {}
  Show 9 fieldsHide fields
  filterFilterNodeor null
  sortsobject[]
  Show 2 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  groupByGroupByInputor null
  Show 6 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]
  hideEmptyboolean
  Hide groups with no rows (board columns).
  dateBucketstring
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]
  subGroupByGroupByInputor null
  Board swimlanes.
  Show 6 fieldsHide fields
  propertyIdULIDrequired
  directionstring
  One ofascdesc
  Default "asc"
  orderstring[]
  hideEmptyboolean
  Hide groups with no rows (board columns).
  dateBucketstring
  Date grouping; default month.
  One ofdayweekmonthyear
  collapsedstring[]
  columnsViewColumnInput[]
  Show 3 fieldsHide fields
  propertyIdULIDrequired
  visibleboolean
  Default true
  widthinteger· 20–2000
  limitintegeror null· ≥ 1
  summariesobject
  propertyId → summary name
  layoutViewLayoutInput
  Show 11 fieldsHide fields
  rowHeightstring
  table
  One ofshortmediumtallextra
  wrapCellsboolean
  table
  cardSizeinteger· 50–1000
  board, gallery: px
  coverobjector null
  board, gallery: the card image
  coverFitstring
  One ofcovercontain
  coverAspectRationumber· 0.1–10
  markersstring
  list
  One ofbulletnumbernone
  calendarPropertyIdULID
  calendar: the date property placing rows
  calendarModestring
  One ofmonthweek
  showWeekendsboolean
  colorColumnsboolean
  board
  extraobject
windowobject
Default {"offset":0,"limit":100}
Show 5 fieldsHide fields
- offsetinteger
  Default 0
- limitinteger· 0–1000
  Default 100
- groupstringor null
- subGroupstringor null
- rangeobject
  Show 3 fieldsHide fields
  propertyIdULID
  Default: the view's calendar property.
  startstringrequired
  Inclusive, YYYY-MM-DD
  endstringrequired
  Exclusive, YYYY-MM-DD
todaystring
The caller's local date for relative date filters. Default: the server's.

Response

totalinteger
offsetinteger
rowsViewRow[]
Show 11 fieldsHide fields
- idULID
- titlestring
- sortKeystring· 1–256 chars
- propertiesobject
- createdAttimestamp
- updatedAttimestamp
- createdBystringor null· ≥ 1 chars
- updatedBystringor null· ≥ 1 chars
- groupstringor null
  The row's group (null: no value or not grouped).
- subGroupstringor null
- computedobject
groupsViewGroup[]
Show 4 fieldsHide fields
- keystringor null
- subKeystringor null
  Set for sub-groups (board swimlanes); null otherwise.
- countinteger
- startinteger

200

{
  "total": 0,
  "offset": 0,
  "rows": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "title": "Meeting notes",
      "sortKey": "a0",
      "properties": {},
      "createdAt": "2026-11-12T09:30:00.000Z",
      "updatedAt": "2026-11-12T09:30:00.000Z",
      "createdBy": null,
      "updatedBy": null,
      "group": null,
      "subGroup": null,
      "computed": {}
    }
  ],
  "groups": [
    {
      "key": null,
      "subKey": null,
      "count": 0,
      "start": 0
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.