Table Fields

Get Table Field

Retrieve details of a specific field.

GET/databases/{databaseId}/tables/{tableId}/fields/{fieldId}

Request

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

import json
import requests

url = "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields/<fieldId>"
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>/fields/<fieldId>", {
  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>/fields/<fieldId>");
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>/fields/<fieldId>", 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>/fields/<fieldId>"))
    .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>/fields/<fieldId>")
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>",
    "name": "<string>",
    "description": "<string>",
    "type": "SINGLE_LINE_TEXT",
    "options": {},
    "allowMultipleEntries": true,
    "readonly": true,
    "required": true,
    "locked": true,
    "defaultValue": "<string>",
    "aiOptions": {
      "aiFillable": true,
      "aiOnly": true,
      "allowWebSearch": true,
      "aiModel": "<string>",
      "prompt": "<string>",
      "canBeTriggeredManually": true,
      "runWhenRecordIsCreated": true,
      "runWhenRecordIsUpdated": true
    },
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

Authorizations

Softr-Api-KeyAPI key · headerrequired

Path Parameters

databaseIdstringrequired

tableIdstringrequired

fieldIdstringrequired

Response

application/json

Field details.

dataobject

Show child attributes

data.idstring

data.namestring

data.descriptionstring | null

Optional description of the field.

data.typeenum<string>

The type of the field.

Available options: SINGLE_LINE_TEXT, CHECKBOX, CURRENCY, DATE, DATETIME, DURATION, EMAIL, SELECT, NUMBER, ATTACHMENT, RATING, LINKED_RECORD, LONG_TEXT, URL, PERCENT, PHONE, LOOKUP, ROLLUP, FORMULA, CREATED_AT, UPDATED_AT, CREATED_BY, UPDATED_BY, AUTONUMBER, RECORD_ID, USER

data.optionsRecord<string, unknown>

Configuration options for the field, specific to its type. See the official documentation for the structure of each type.

data.allowMultipleEntriesboolean

data.readonlyboolean

data.requiredboolean

data.lockedboolean

data.defaultValuestring | null

data.aiOptionsobject | null

AI-powered auto-fill configuration. Null if not configured.

Show child attributes

data.aiOptions.aiFillableboolean

data.aiOptions.aiOnlyboolean

data.aiOptions.allowWebSearchboolean

data.aiOptions.aiModelstring

data.aiOptions.promptstring

data.aiOptions.canBeTriggeredManuallyboolean

data.aiOptions.runWhenRecordIsCreatedboolean

data.aiOptions.runWhenRecordIsUpdatedboolean

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

{ "data": { "id": "<string>", "name": "<string>", "description": "<string>", "type": "SINGLE_LINE_TEXT", "options": {}, "allowMultipleEntries": true, "readonly": true, "required": true, "locked": true, "defaultValue": "<string>", "aiOptions": { "aiFillable": true, "aiOnly": true, "allowWebSearch": true, "aiModel": "<string>", "prompt": "<string>", "canBeTriggeredManually": true, "runWhenRecordIsCreated": true, "runWhenRecordIsUpdated": true }, "createdAt": "2024-01-01T00:00:00Z", "updatedAt": "2024-01-01T00:00:00Z" } }

Get Table Field

Authorizations

Path Parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown