Skip to main content
GET
/
runtime
/
{sourceId}
/
{table}
List records from a source table
curl --request GET \
  --url https://your-synthbrew-server.com/api/runtime/{sourceId}/{table} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 1,
      "customer_id": 1,
      "status": "paid",
      "total": 100.5,
      "_populated": {
        "customer_id": {
          "id": 1,
          "name": "Alice"
        }
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "count": 1,
    "total": 4
  }
}

Authorizations

​
x-api-key
string
header
required

Source API key created under /api/sources/:sourceId/api-keys

Path Parameters

​
sourceId
string<uuid>
required

Source UUID. For runtime endpoints this identifies the source backing the table; for public v1 it identifies the source resource inside the project.

​
table
string
required

Runtime table identifier (usually the schema entity ID used in Synthbrew).

Query Parameters

​
limit
integer
default:50

Maximum number of rows returned per page. Use with offset for pagination.

Required range: 1 <= x <= 500
​
offset
integer
default:0

Number of rows to skip before returning results. Useful for page-based pagination.

Required range: x >= 0
​
fields
string

Comma-separated list of top-level fields to include in each returned row. Example: id,total,status

​
sort
string

Comma-separated sort tokens in :asc|desc format. Example: created_at:desc,id:asc. Sorts are applied left-to-right.

​
populate
string

Comma-separated relation field IDs to populate. Example: customer_id. Populated data is returned under _populated..

​
filters.<field>.<operator>
string

Dynamic filter key pattern. Example: filters.status.$eq=paid, filters.total.$gte=50, filters.id.$in=1,2,3, filters.note.$null=true. Operators: $eq, $ne, $gt, $gte, $lt, $lte, $in, $notIn, $contains, $containsi, $startsWith, $endsWith, $null.

​
populate.<field>.fields
string

Specify fields returned for a populated relation. Example: populate.customer_id.fields=id,name

Response

Paginated runtime rows

Paginated runtime table result.

​
data
object[]
required
​
pagination
object
required