Tables

Query table rows

Queries table rows as JSON with optional column selection, filtering, sorting and offset pagination. Returns the matching rows plus pagination metadata: total, total_pages and current_page. The query is sent as a JSON request body — see the fields below, and the Querying guide for the full filter grammar and examples.

Last updated on

POST
/namespaces/{namespace}/tables/{tableName}/query

Path Parameters

namespace*string
tableName*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Query definition sent as the JSON request body. All fields are optional; an empty body {} returns the first page of all columns.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/namespaces/string/tables/string/query" \  -H "Content-Type: application/json" \  -d '{    "limit": 10,    "offset": 0,    "select": "lytis,mirties_metai,pavadinimas",    "filter": "lytis=Moteris",    "sort": "-mirties_metai",    "exclude_nulls": [      "m_konc"    ]  }'
{
  "data": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "total": 0,
  "total_pages": 0,
  "current_page": 0
}
{
  "error": "string",
  "error_code": "string"
}
{
  "message": "string",
  "error_code": "string"
}
{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "string",
      "type": "string",
      "input": "string",
      "ctx": {
        "property1": null,
        "property2": null
      }
    }
  ]
}
{
  "error": "string",
  "error_code": "string"
}
{
  "error": "string",
  "error_code": "string"
}

See also

How is this guide?