How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Budibase Public API

The complete Budibase Public API as Budibase itself publishes it — OpenAPI 3.1.0, info.version 3.3.0, 44 operations across workspaces, applications, tables, rows, views, users, roles, queries and metrics. Harvested verbatim on 2026-09-04 from packages/server/specs/openapi.yaml in the Budibase monorepo, the location Budibase's own Public API documentation directs integrators to. Supersedes the five per-tag splits below in coverage: those describe 26 operations and omit workspaces, views, roles and metrics entirely.

Budibase Public API is one of 6 APIs that Budibase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application, Tables, Rows, User, and Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 44 operations across 32 paths, organized into 9 resource areas, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 3.3.0.

Requests are made against a single base URL, https://budibase.app/api/public/v1.

44 operations 32 paths 30 schemas 6 DELETE7 GET25 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.3.0
Base URL
https://budibase.app/api/public/v1
Authentication
API Key
Resource Areas
9

Authentication & Security 1

Budibase Public API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-budibase-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your individual API key, this will provide access based on the configured RBAC settings of your user.

Paths & Operations 44

Across 32 paths, the API surfaces 44 operations — 6 DELETE, 7 GET, 25 POST, 6 PUT. They span 9 resource areas: applications, metrics, queries, roles, rows, tables, users, views, workspaces. Each is listed below with its method, path, parameters, and response codes.

applications 9
POST
/applicationsdeprecated
Create an application
appCreate 1 param body → 200
PUT
/applications/{appId}deprecated
Update an application
appUpdate 1 param body → 200
DELETE
/applications/{appId}deprecated
Delete an application
appDestroy 1 param → 200
GET
/applications/{appId}deprecated
Retrieve an application
appGetById 1 param → 200
POST
/applications/{appId}/unpublishdeprecated
Unpublish an application
appUnpublish 1 param → 204
POST
/applications/{appId}/publishdeprecated
Publish an application
appPublish 1 param → 200
POST
/applications/{appId}/importdeprecated
Import an app to an existing app 🔒
appImport 1 param body → 204
POST
/applications/{appId}/exportdeprecated
Export an app 🔒
appExport 1 param body → 200
POST
/applications/searchdeprecated
Search for applications
appSearch body → 200
metrics 1
GET
/metrics
Retrieve Budibase tenant metrics
metricsGet → 200
queries 2
POST
/queries/{queryId}
Execute a query
queryExecute 2 params body → 200
POST
/queries/search
Search for queries
querySearch 1 param body → 200
roles 2
POST
/roles/assign
Assign a role to a list of users
roleAssign body → 200
POST
/roles/unassign
Un-assign a role from a list of users
roleUnAssign body → 200
rows 6
POST
/tables/{tableId}/rows
Create a row
rowCreate 2 params body → 200
PUT
/tables/{tableId}/rows/{rowId}
Update a row
rowUpdate 3 params body → 200
DELETE
/tables/{tableId}/rows/{rowId}
Delete a row
rowDestroy 3 params → 200
GET
/tables/{tableId}/rows/{rowId}
Retrieve a row
rowGetById 3 params → 200
POST
/tables/{tableId}/rows/search
Search for rows
rowSearch 2 params body → 200
POST
/views/{viewId}/rows/search
Search for rows in a view
rowViewSearch 2 params body → 200
tables 5
POST
/tables
Create a table
tableCreate 1 param body → 200
PUT
/tables/{tableId}
Update a table
tableUpdate 2 params body → 200
DELETE
/tables/{tableId}
Delete a table
tableDestroy 2 params → 200
GET
/tables/{tableId}
Retrieve a table
tableGetById 2 params → 200
POST
/tables/search
Search for tables
tableSearch 1 param body → 200
users 5
POST
/users
Create a user
userCreate body → 200
PUT
/users/{userId}
Update a user
userUpdate 1 param body → 200
DELETE
/users/{userId}
Delete a user
userDestroy 1 param → 200
GET
/users/{userId}
Retrieve a user
userGetById 1 param → 200
POST
/users/search
Search for users
userSearch body → 200
views 5
POST
/views
Create a view
viewCreate 1 param body → 200
PUT
/views/{viewId}
Update a view
viewUpdate 2 params body → 200
DELETE
/views/{viewId}
Delete a view
viewDestroy 2 params → 200
GET
/views/{viewId}
Retrieve a view
viewGetById 2 params → 200
POST
/views/search
Search for views
viewSearch 1 param body → 200
workspaces 9
POST
/workspaces
Create a workspace
workspaceCreate body → 200
PUT
/workspaces/{workspaceId}
Update a workspace
workspaceUpdate 1 param body → 200
DELETE
/workspaces/{workspaceId}
Delete a workspace
workspaceDestroy 1 param → 200
GET
/workspaces/{workspaceId}
Retrieve a workspace
workspaceGetById 1 param → 200
POST
/workspaces/{workspaceId}/publish
Publish a workspace
workspacePublish 1 param → 200
POST
/workspaces/{workspaceId}/unpublish
Unpublish a workspace
workspaceUnpublish 1 param → 204
POST
/workspaces/{workspaceId}/import
Import a workspace to an existing workspace 🔒
workspaceImport 1 param body → 204
POST
/workspaces/{workspaceId}/export
Export a workspace 🔒
workspaceExport 1 param body → 200
POST
/workspaces/search
Search for workspaces
workspaceSearch body → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are query (9 properties), user (9 properties), view (7 properties), rolesAssign (5 properties). Each schema is shown below with its type and property counts.

application
object
2 properties 1 required
workspace
object
2 properties 1 required
applicationOutput
object
1 property 1 required
workspaceOutput
object
1 property 1 required
applicationSearch
object
1 property 1 required
workspaceSearch
object
1 property 1 required
deploymentOutput
object
1 property 1 required
appExport
object
2 properties 2 required
workspaceExport
object
2 properties 2 required
row
object
The row to be created/updated, based on the table schema.
searchOutput
object
3 properties 1 required
rowOutput
object
1 property 1 required
table
object
The table to be created/updated.
3 properties 2 required
tableOutput
object
1 property 1 required
tableSearch
object
1 property 1 required
executeQuery
object
The parameters required for executing a query.
2 properties
executeQueryOutput
object
3 properties 1 required
query
object
9 properties 3 required
querySearch
object
1 property 1 required
user
object
9 properties 1 required
userOutput
object
1 property 1 required
userSearch
object
1 property 1 required
rowSearch
object
5 properties 1 required
nameSearch
object
1 property 1 required
rolesAssign
object
5 properties 1 required
rolesUnAssign
object
5 properties 1 required
rolesOutput
object
1 property 1 required
view
object
The view to be created/updated.
7 properties 3 required
viewOutput
object
1 property 1 required
viewSearch
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

budibase-public-api-openapi.yml Raw ↑

Other APIs Budibase publishes across the network.

Budibase Applications API
Budibase Queries API
Budibase Rows API
Budibase Tables API
Budibase Users API
Where this information came from

This is an independent, third-party profile of Budibase Public API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.