Baserow Applications API

openapi: 3.2.0
info:
  title: Baserow API spec Admin Applications API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
servers:
- url: https://api.baserow.io
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Applications
paths:
  /api/applications/:
    get:
      operationId: list_all_applications
      description: Lists all the applications that the user has access to. The properties that belong to the application can differ per type. An application always belongs to a single workspace. All the applications of the workspaces that the user has access to are going to be listed here.
      tags:
      - Applications
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApplicationApplication'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/applications/{application_id}/:
    get:
      operationId: workspace_get_application
      description: Returns the requested application if the authorized user is in the application's workspace. The properties that belong to the application can differ per type.
      parameters:
      - in: path
        name: application_id
        schema:
          type: integer
        description: Returns the application related to the provided value.
        required: true
      tags:
      - Applications
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApplication'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    patch:
      operationId: workspace_update_application
      description: Updates the existing application related to the provided `application_id` param if the authorized user is in the application's workspace. It is not possible to change the type, but properties like the name can be changed.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: header
        name: ClientUndoRedoActionGroupId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
      - in: path
        name: application_id
        schema:
          type: integer
        description: Updates the application related to the provided value.
        required: true
      tags:
      - Applications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedApplicationBaseApplicationUpdatePolymorphic'
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApplication'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    delete:
      operationId: workspace_delete_application
      description: Deletes an application if the authorized user is in the application's workspace. All the related children are also going to be deleted. For example in case of a database application all the underlying tables, fields, views and rows are going to be deleted.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: header
        name: ClientUndoRedoActionGroupId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
      - in: path
        name: application_id
        schema:
          type: integer
        description: Deletes the application related to the provided value.
        required: true
      tags:
      - Applications
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_CANNOT_DELETE_ALREADY_DELETED_ITEM
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/applications/{application_id}/duplicate/async/:
    post:
      operationId: duplicate_application_async
      description: Duplicate an application if the authorized user is in the application's workspace. All the related children are also going to be duplicated. For example in case of a database application all the underlying tables, fields, views and rows are going to be duplicated.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: header
        name: ClientUndoRedoActionGroupId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
      - in: path
        name: application_id
        schema:
          type: integer
        description: The id of the application to duplicate.
        required: true
      tags:
      - Applications
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateApplicationJobTypeResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_APPLICATION_NOT_IN_GROUP
                    - ERROR_MAX_JOB_COUNT_EXCEEDED
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_APPLICATION_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/applications/workspace/{workspace_id}/:
    get:
      operationId: workspace_list_applications
      description: Lists all the applications of the workspace related to the provided `workspace_id` parameter if the authorized user is in that workspace. If theworkspace is related to a template, then this endpoint will be publicly accessible. The properties that belong to the application can differ per type. An application always belongs to a single workspace.
      parameters:
      - in: path
        name: workspace_id
        schema:
          type: integer
        description: Returns only applications that are in the workspace related to the provided value.
        required: true
      tags:
      - Applications
      security:
      - UserSource JWT: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApplicationApplication'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_GROUP_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    post:
      operationId: workspace_create_application
      description: Creates a new application based on the provided type. The newly created application is going to be added to the workspace related to the provided `workspace_id` parameter. If the authorized user does not belong to the workspace an error will be returned.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: header
        name: ClientUndoRedoActionGroupId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
      - in: path
        name: workspace_id
        schema:
          type: integer
        description: Creates an application for the workspace related to the provided value.
        required: true
      tags:
      - Applications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ApplicationBaseApplicationCreatePolymorphic'
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationApplication'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_GROUP_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
  /api/applications/workspace/{workspace_id}/order/:
    post:
      operationId: workspace_order_applications
      description: Changes the order of the provided application ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the not provided tables will be set to `0`.
      parameters:
      - in: header
        name: ClientSessionId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
      - in: header
        name: ClientUndoRedoActionGroupId
        schema:
          type: string
          format: uuid
        description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
      - in: path
        name: workspace_id
        schema:
          type: integer
        description: Updates the order of the applications in the workspace related to the provided value.
        required: true
      tags:
      - Applications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderApplications'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrderApplications'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrderApplications'
        required: true
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_APPLICATION_NOT_IN_GROUP
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_GROUP_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  schemas:
    LoadTypeEnum:
      enum:
      - defer
      - async
      type: string
      description: '* `` - None

        * `defer` - Defer

        * `async` - Async'
    RoleTypeEnum:
      enum:
      - allow_all
      - allow_all_except
      - disallow_all_except
      type: string
      description: '* `allow_all` - Allow All

        * `allow_all_except` - Allow All Except

        * `disallow_all_except` - Disallow All Except'
    PageBackgroundModeEnum:
      enum:
      - tile
      - fill
      - fit
      type: string
      description: '* `tile` - Tile

        * `fill` - Fill

        * `fit` - Fit'
    LinkTextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    BodyFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    ButtonFontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    Heading6FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    Heading1TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    Heading3FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    Heading3TextAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    DashboardBaseApplicationUpdatePolymorphic:
      type: object
      properties:
        name:
          type: string
          maxLength: 160
        description:
          type: string
      required:
      - name
    AutomationWorkflow:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 255
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Lowest first.
        automation_id:
          type: integer
          readOnly: true
        allow_test_run_until:
          type:
          - string
          - 'null'
          format: date-time
        simulate_until_node_id:
          type:
          - integer
          - 'null'
          description: When set, upon the next workflow run, simulates the dispatch of the workflow until this node and updates the sample_data of the node's service.
          readOnly: true
        published_on:
          type: string
          readOnly: true
        state:
          type: string
          readOnly: true
        graph:
          description: Contains the node graph.
        notification_recipient_ids:
          type: array
          items:
            type: integer
          readOnly: true
      required:
      - automation_id
      - id
      - name
      - notification_recipient_ids
      - order
      - published_on
      - simulate_until_node_id
      - state
    DuplicateApplicationJobTypeResponse:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
          description: The type of the job.
        progress_percentage:
          type: integer
          description: A percentage indicating how far along the job is. 100 means that it's finished.
        state:
          type: string
          description: Indicates the state of the import job.
        human_readable_error:
          type: string
          description: A human readable error message indicating what went wrong.
        created_on:
          type: string
          format: date-time
          readOnly: true
        updated_on:
          type: string
          format: date-time
          readOnly: true
        original_application:
          allOf:
          - $ref: '#/components/schemas/ApplicationApplication'
          readOnly: true
        duplicated_application:
          allOf:
          - $ref: '#/components/schemas/ApplicationApplication'
          readOnly: true
      required:
      - created_on
      - duplicated_application
      - id
      - original_application
      - progress_percentage
      - state
      - type
      - updated_on
    CustomScript:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/CustomScriptTypeEnum'
          description: 'The type of script.


            * `stylesheet` - Stylesheet

            * `javascript` - JavaScript'
        url:
          type: string
          format: uri
          description: The URL of the script.
          maxLength: 200
        load_type:
          description: 'The load type of the script.


            * `` - None

            * `defer` - Defer

            * `async` - Async'
          oneOf:
          - $ref: '#/components/schemas/LoadTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        crossorigin:
          description: 'The Crossorigin type of the script.


            * `` - None

            * `anonymous` - Anonymous

            * `credentials` - Use credentials'
          oneOf:
          - $ref: '#/components/schemas/CrossoriginEnum'
          - $ref: '#/components/schemas/BlankEnum'
      required:
      - id
    Type76dEnum:
      enum:
      - database
      - dashboard
      - automation
      - builder
      type: string
      description: '* `database` - database

        * `dashboard` - dashboard

        * `automation` - automation

        * `builder` - builder'
    ImageAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    TableCellAlignmentEnum:
      enum:
      - left
      - center
      - right
      type: string
      description: '* `left` - Left

        * `center` - Center

        * `right` - Right'
    Heading2FontWeightEnum:
      enum:
      - thin
      - extra-light
      - light
      - regular
      - medium
      - semi-bold
      - bold
      - extra-bold
      - heavy
      - black
      - extra-black
      type: string
      description: '* `thin` - Thin

        * `extra-light` - Extra Light

        * `light` - Light

        * `regular` - Regular

        * `medium` - Medium

        * `semi-bold` - Semi Bold

        * `bold` - Bold

        * `extra-bold` - Extra Bold

        * `heavy` - Heavy

        * `black` - Black

        * `extra-black` - Extra Black'
    BuilderBaseApplicationCreatePolymorphic:
      type: object
      properties:
  

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/openapi/baserow-applications-api-openapi.yml