Softr Databases API

List and manage Softr Databases.

OpenAPI Specification

softr-databases-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Softr Databases API
  description: Public REST APIs for Softr - the no-code app and client-portal builder. Covers the Users Management API (studio-api.softr.io) for managing the end users of a published Softr app, and the Softr Database API (tables-api.softr.io) for reading and writing records in the native Softr Database. Both APIs authenticate with a Softr-Api-Key header; the Users Management API additionally requires a Softr-Domain header identifying the target app.
  termsOfService: https://www.softr.io/terms
  contact:
    name: Softr Support
    url: https://docs.softr.io
  version: '1.0'
servers:
- url: https://studio-api.softr.io/v1/api
  description: Users Management API
- url: https://tables-api.softr.io/api/v1
  description: Softr Database API
security:
- SoftrApiKey: []
tags:
- name: Databases
  description: List and manage Softr Databases.
paths:
  /databases:
    get:
      operationId: listDatabases
      tags:
      - Databases
      summary: List databases
      description: Lists the Softr Databases accessible to the API token.
      servers:
      - url: https://tables-api.softr.io/api/v1
      responses:
        '200':
          description: A list of databases.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Database'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Database:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid Softr-Api-Key (or Softr-Domain).
  securitySchemes:
    SoftrApiKey:
      type: apiKey
      in: header
      name: Softr-Api-Key
      description: Personal access token generated from the Softr workspace settings.