Skip to main content
GET
List the rows of a table

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

table
string
required

The name of a table of the site's database, letters, digits and underscores, starting with a letter or underscore, at most 63 characters. A table that is not in the database's public schema is 404.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$

Query Parameters

sort
string

The columns to order by, comma separated, at most 10, each with an optional leading - for descending, such as -created_at,name. The order always ends with the table's primary key, so equal values page stably.

Maximum string length: 700
page[limit]
integer

How many rows to list, 25 when omitted, at most 100.

Required range: 1 <= x <= 100
page[cursor]
string

The meta.pagination.next_cursor of the previous page. It is tied to the table, filters and sort it was issued for.

Maximum string length: 2048

Response

A page of rows.

One page of a table's rows.

status
integer
required

HTTP status code (mirrors the response status line).

data
object[]
required

The rows of the page. A page ends at page[limit] rows, or before 192 KiB of rows, whichever comes first.

meta
object
required

Envelope metadata present on every response.