Records

Get Records

Retrieve a list of all records in the specified table.

GET/databases/{databaseId}/tables/{tableId}/records

Request

curl --request GET \
  --url 'https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records' \
  --header 'Softr-Api-Key: <api-key>'

import json
import requests

url = "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records"
headers = {
  "Softr-Api-Key": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records", {
  method: "GET",
  headers: {
    "Softr-Api-Key": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Softr-Api-Key: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records", nil)
  req.Header.Set("Softr-Api-Key", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records"))
    .header("Softr-Api-Key", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/records")
request = Net::HTTP::Get.new(uri)
request["Softr-Api-Key"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": [
    {
      "id": "<string>",
      "tableId": "<string>",
      "fields": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "metadata": {
    "offset": 123,
    "limit": 123,
    "total": 123
  }
}

Authorizations

Softr-Api-KeyAPI key · headerrequired

Path Parameters

databaseIdstringrequired

tableIdstringrequired

Query Parameters

offsetintegerdefault: 0

limitintegerdefault: 10

fieldNamesbooleandefault: false

If true, use field names as keys in the fields object instead of field IDs.

viewIdstring

Filter records by a specific view.

Response

application/json

A paginated list of records.

dataobject[]

Show child attributes

data.idstring

data.tableIdstring

data.fieldsRecord<string, unknown>

A map of Field IDs to their values for this record.

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

metadataobject

Show child attributes

metadata.offsetinteger

metadata.limitinteger

metadata.totalinteger

{ "data": [ { "id": "<string>", "tableId": "<string>", "fields": {}, "createdAt": "2024-01-01T00:00:00Z", "updatedAt": "2024-01-01T00:00:00Z" } ], "metadata": { "offset": 123, "limit": 123, "total": 123 } }

Get Records

Authorizations

Path Parameters

Query Parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown