API Reference

List Rows (with SQL)

Lists rows in a table based on an SQL-query provided in the request. Also returns the metadata of the table.

Typical SQL-statements are supported. Below some basic examples:
SELECT name, age, birthday, gender FROM Participants

SELECT name, surname FROM Participants ORDER BY name

SELECT * FROM Participants LIMIT 25
For more details, check the SQL-syntax supported by SeaTable.

📘

Returns also data from the big data backend

This request is the only available endpoint that returns rows stored in the big data backend.

🚧

Returns at most 10 000 rows

The request returns a maximum of 10 000 rows regardless of the limit specified in the SQL-statement.

❗️

CURL does not follow redirects by default (relevant especially for SeaTable Cloud)

SeaTable Cloud (version 5.0 and newer) redirects this endpoint to the new API gateway endpoint using a 302 header redirect.
If you curl command does not return any result, you need to add the -L parameter to follow these redirects. Most other clients handle redirects automatically.

Path Params
string
required

The unique identifier of a base. Sometimes also called dtable_uuid.

Body Params

description des requestBody

string
required

SQL-Query to get rows from base

boolean

Determines if the columns are returned as their keys (false by default) or their names (true).

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json