Softr

https://docs.softr.io/
Admin
Softr is a no-code platform for building web applications with databases, workflows, user...
Tokens:395,656
Snippets:4,554
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api/v1/databases

Source: https://docs.softr.io/softr-api/softr-database-api/index

Lists all databases accessible with the provided Personal Access Token. This is the first step in the quick start guide.

```APIDOC
## GET /api/v1/databases

### Description
Lists all databases accessible with the provided Personal Access Token.

### Method
GET

### Endpoint
https://tables-api.softr.io/api/v1/databases

### Parameters
#### Headers
- **Softr-Api-Key** (string) - Required - Personal Access Token for authentication.

### Request Example
```
curl -X GET 'https://tables-api.softr.io/api/v1/databases' \
  -H 'Softr-Api-Key: <your-token>'
```

### Response
#### Success Response (200)
- **data** (array) - List of database objects.
- **metadata** (object) - Pagination metadata (offset, limit, total).

#### Response Example
```
{
  "data": [ ... ],
  "metadata": {
    "offset": 0,
    "limit": 20,
    "total": 100
  }
}
```

### Error Codes
- `UNAUTHORIZED` (401) - Missing or invalid token.
- `FORBIDDEN` (403) - Insufficient permissions.
- `TOO_MANY_REQUESTS` (429) - Rate limit exceeded.
- `SERVICE_UNAVAILABLE` (503) - Service temporarily unavailable.
```

--------------------------------

### Get Single Table with Go

Source: https://docs.softr.io/softr-api/softr-database-api/tables/get-single-table

Go example using net/http to fetch a single table. Replace the URL placeholders and set your API key in the request header.

```go
package main

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

func main() {

	url := "https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Softr-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example: create table

Source: https://docs.softr.io/softr-api/softr-database-api/tables/create-table

Uses Go's net/http to create a table.

```go
package main

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

func main() {

	url := "https://tables-api-softr.io/api/v1/databases/{databaseId}/tables"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"primaryFieldName\": \"<string>\",\n  \"fields\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"options\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Softr-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### 200 Response Example for Get Single Database

Source: https://docs.softr.io/softr-api/softr-database-api/databases/get-single-database

Example 200 response body for the Get Single Database endpoint. Contains the database data object with id, name, description, workspaceId, tablesCount, createdAt, and updatedAt fields.

```json
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "workspaceId": "<string>",
    "tablesCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
```

--------------------------------

### Python example: create table

Source: https://docs.softr.io/softr-api/softr-database-api/tables/create-table

Python example using the requests library to create a table.

```python
import requests

url = "https://tables-api-softr.io/api/v1/databases/{databaseId}/tables"

payload = {
    "name": "<string>",
    "description": "<string>",
    "primaryFieldName": "<string>",
    "fields": [
        {
            "name": "<string>",
            "type": "<string>",
            "options": {}
        }
    ]
}
headers = {
    "Softr-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

```

--------------------------------

### Get Table Views - 200 Response Example

Source: https://docs.softr.io/softr-api/softr-database-api/tables/get-table-views

Example 200 response body for the Get Table Views endpoint. Contains a data array with view objects, each having id, tableId, name, description, createdAt, and updatedAt fields.

```json
{
  "data": [
    {
      "id": "<string>",
      "tableId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
```

--------------------------------

### JavaScript fetch example: create table

Source: https://docs.softr.io/softr-api/softr-database-api/tables/create-table

JavaScript example using fetch to create a table.

```javascript
const options = {
  method: 'POST',
  headers: {'Softr-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    primaryFieldName: '<string>',
    fields: [{name: '<string>', type: '<string>', options: {}}]
  })
};

fetch('https://tables-api-softr.io/api/v1/databases/{databaseId}/tables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

```

--------------------------------

### 200 Response for Get Single Table

Source: https://docs.softr.io/softr-api/softr-database-api/tables/get-single-table

Example 200 response body for the Get Single Table endpoint. Shows the structure of the returned table data, including fields and AI options.

```json
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "primaryFieldId": "<string>",
    "defaultViewId": "<string>",
    "fields": [
      {
        "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": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
```

--------------------------------

### Authentication Example

Source: https://docs.softr.io/softr-api/softr-database-api/authorisation

All API requests must be authenticated. Pass your Personal Access Token (PAT) in the `Softr-Api-Key` header.

```APIDOC
## Authentication Example

### Description

This example demonstrates how to authenticate an API request using a Personal Access Token (PAT).

### Method

GET

### Endpoint

https://tables-api.softr.io/api/v1/databases

### Headers

- **Softr-Api-Key** (string) - Required - Your Personal Access Token

### Request Example

```bash
curl -X GET "https://tables-api.softr.io/api/v1/databases" \
  -H "Softr-Api-Key: <your-token>"
```
```

--------------------------------

### Get Single Record

Source: https://docs.softr.io/softr-api/softr-database-api/records/get-single-record

Complete API documentation for the Get Single Record endpoint, including endpoint URL, parameters, headers, example requests in multiple languages, and response schema.

```APIDOC
## Get Single Record

Retrieves a single record from a Softr database table.

### Endpoint

`GET /api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}`

### Base URL

`https://tables-api.softr.io`

### Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `databaseId` | string | Yes | The unique identifier of the database. |
| `tableId` | string | Yes | The unique identifier of the table. |
| `recordId` | string | Yes | The unique identifier of the record. |

### Headers

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `Softr-Api-Key` | string | Yes | Your Softr API key. |

### Example Request (cURL)

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

### Example Request (Python)

```python
import requests

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

response = requests.get(url, headers=headers)

print(response.text)
```

### Example Request (JavaScript)

```javascript
const options = {method: 'GET', headers: {'Softr-Api-Key': '<api-key>'}};

fetch('https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
```

### Example Request (PHP)

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Softr-Api-Key: <api-key>"],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

### Example Request (Go)

```go
package main

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

func main() {

	url := "https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Softr-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

### Example Request (Java)

```java
HttpResponse<String> response = Unirest.get("https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}")
  .header("Softr-Api-Key", "<api-key>")
  .asString();
```

### Example Request (Ruby)

```ruby
require 'uri'
require 'net/http'

url = URI("https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/records/{recordId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Softr-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

### Response

**Status Code:** `200 OK`

**Response Body:**

```json
{
  "data": {
    "id": "<string>",
    "tableId": "<string>",
    "fields": {},
    "createdAt": "2023-..."
  }
}
```

### Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `data.id` | string | The unique identifier of the record. |
| `data.tableId` | string | The identifier of the table containing the record. |
| `data.fields` | object | The field values of the record. |
| `data.createdAt` | string | The timestamp when the record was created. |
```

--------------------------------

### Create User API Call

Source: https://docs.softr.io/softr-api/api-setup-and-endpoints

Example of creating a user in a Softr app using the API.

```bash
curl --request POST 'https://studio-api.softr.io/v1/api/users' \
--header 'Softr-Api-Key: uYGskr7MqMeRYrjQjsB8uEQ8n' \
--header 'Softr-Domain: yourdomain.com' \
--header 'Content-Type: application/json' \
--data-raw '{
  "full_name": "John Richardson",
  "email": "johnr@gmail.com",
  "password": "12345678",
  "generate_magic_link":true
}'
```

--------------------------------

### WEEKNUM formula example

Source: https://docs.softr.io/softr-databases/57RHfyrVrq5xPojyELRnSu/formula-glossary/57RHfyrVrpgXaYL5w8E4uR

Returns the week number of the year for a given date. By default, the week starts on Sunday. Pass “monday” as the second argument to start the week on Monday instead.

```plaintext
WEEKNUM({Due Date})
```

--------------------------------

### WEEKDAY formula examples

Source: https://docs.softr.io/softr-databases/57RHfyrVrq5xPojyELRnSu/formula-glossary/57RHfyrVrpgXaYL5w8E4uR

Returns the day of the week as a number. By default, the week starts on Sunday (0 = Sunday, 1 = Monday, …, 6 = Saturday). Pass “monday” as the second argument to start the week on Monday instead.

```plaintext
WEEKDAY({Due Date})
```

```plaintext
WEEKDAY({Due Date}, "monday")
```

--------------------------------

### Create Table with Go

Source: https://docs.softr.io/softr-api/softr-database-api/tables/create-table

Use this Go program to create a table. It builds the request with the JSON payload, sends it, and prints the response body.

```go
package main

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

func main() {

	url := "https://tables-api.softr.io/api/v1/databases/{databaseId}/tables"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"primaryFieldName\": \"<string>\",\n  \"fields\": [\n    {\n      \"name\": \"<string>\",\n      \"type\": \"<string>\",\n      \"options\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Softr-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### DATEADD Function

Source: https://docs.softr.io/softr-databases/57RHfyrVrq5xPojyELRnSu/formula-glossary/57RHfyrVrpgXaYL5w8E4uR

Adds a specified number of units (e.g., days, months) to a date. Example adds 7 days to Start Date.

```formula
DATEADD({Start Date}, 7, "days")
```

--------------------------------

### Softr API Pagination Example

Source: https://docs.softr.io/softr-api/softr-database-api

Demonstrates how to use offset and limit parameters to paginate through records. Continue fetching records until the offset is greater than or equal to the total number of records.

```http
GET .../records?offset=0&limit=100    → records 1–100
GET .../records?offset=100&limit=100  → records 101–200
GET .../records?offset=200&limit=100  → records 201–300
```

--------------------------------

### Get Single Table with Java Unirest

Source: https://docs.softr.io/softr-api/softr-database-api/tables/get-single-table

Java example using Unirest to fetch a single table. Replace the URL placeholders and set your API key in the header.

```java
HttpResponse<String> response = Unirest.get("https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}")
  .header("Softr-Api-Key", "<api-key>")
  .asString();
```

--------------------------------

### Go example to update a table field

Source: https://docs.softr.io/softr-api/softr-database-api/table-fields/update-table-field

Uses net/http to send a PUT request with a JSON payload. Reads the response body and prints it.

```go
package main

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

func main() {

	url := "https://tables-api.softr.io/api/v1/databases/{databaseId}/tables/{tableId}/fields/{fieldId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"options\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Softr-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```
Tokens:
Raw