Get Records

Returns the paginated records of the given table specified by the table_name and schema. The API can only return 100 records at a time, starting from the offset number specified.

Parameters

table_name: str
schema : str, default “public” The schema to retrieve the tables from. If no parameter is provided, defaults to “public”.
offset: int, default 0 The offset position of where to select the records from.
limit: int, default 100 The number of records to retrieve. This value must range from 0 and 100.

Returns

A TableRecordsResponse Pydantic object containing the records and total number of records.

GET

api

table

{table_name}

records

curl --request GET \
  --url https://your-engine-url/api/v1/table/{table_name}/records \
  --header 'Authorization: <api-key>'

{
  "records": [
    {}
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Path Parameters

table_name

string

required

Query Parameters

schema

string

default:public

offset

integer

default:0

limit

integer

default:100

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/api/v1/table/{table_name}/records \
  --header 'Authorization: <api-key>'

{
  "records": [
    {}
  ],
  "total": 123
}

Get Records

Returns the paginated records of the given table specified by the table_name and schema. The API can only return 100 records at a time, starting from the offset number specified.

Parameters

table_name: str
schema : str, default “public” The schema to retrieve the tables from. If no parameter is provided, defaults to “public”.
offset: int, default 0 The offset position of where to select the records from.
limit: int, default 100 The number of records to retrieve. This value must range from 0 and 100.

Returns

A TableRecordsResponse Pydantic object containing the records and total number of records.

GET

api

table

{table_name}

records

curl --request GET \
  --url https://your-engine-url/api/v1/table/{table_name}/records \
  --header 'Authorization: <api-key>'

{
  "records": [
    {}
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Path Parameters

table_name

string

required

Query Parameters

schema

string

default:public

offset

integer

default:0

limit

integer

default:100

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/api/v1/table/{table_name}/records \
  --header 'Authorization: <api-key>'

{
  "records": [
    {}
  ],
  "total": 123
}

Authorizations

Path Parameters

Query Parameters

Response

FAQs

Authorizations

Path Parameters

Query Parameters

Response