Skip to main content

Read rows

Read a page of rows, with optional column selection and sorting.

GET /projects/:projectid/databases/:dbid/tables/:tblid/rows

Authentication​

Send the project API key in the Authorization header, without a Bearer prefix. Requires databases.read for the database in the URL.

Request​

Query parameterDescription
columnsComma-separated column names. Omit to return all columns.
orderByOne column to sort by. Omit for no guaranteed order.
orderDirectionASC (default) or DESC; case-insensitive.
limitRows per page. Default 100, maximum 1000.
offsetNumber of rows to skip. Default 0.

Table and column names must follow the identifier rules. This endpoint does not accept a where clause, joins, or search filters; use Run SQL for more complex reads.

Example​

Use the environment variables from the database overview. Replace example IDs with your own.

curl --include --request GET \
--header "Authorization: ${INTELLECTIBLE_PROJECT_API_KEY}" \
--get \
--data-urlencode "columns=customer_name,status" \
--data-urlencode "orderBy=customer_name" \
--data-urlencode "orderDirection=ASC" \
--data-urlencode "limit=100" \
--data-urlencode "offset=0" \
"${INTELLECTIBLE_PUBLIC_API_URL}/projects/${INTELLECTIBLE_PROJECT_ID}/databases/${INTELLECTIBLE_DATABASE_ID}/tables/${INTELLECTIBLE_TABLE_ID}/rows"

Response​

200 OK

{
"rows": [
{
"customer_name": "Ada",
"status": "active"
},
{
"customer_name": "Grace",
"status": "active"
}
],
"limit": 100,
"offset": 0
}

limit and offset report the effective pagination values, not the total row count. Oversized limits are capped at 1000; invalid or non-positive limits fall back to 100. Invalid or negative offsets fall back to 0. An empty result returns rows: [].

For successive pages, increase offset by limit. Sort by a unique column for predictable paging; concurrent changes can still cause offset-based pages to overlap or skip rows. PostgreSQL values such as NUMERIC may be returned as strings to preserve precision.

See Errors and safe retries for shared failure handling.