Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xano Workspace API

Workspace details, branches, import/export.

Xano Workspace API is one of 7 APIs that Xano publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{instance}.xano.io/api:meta.

6 operations 6 paths 3 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://{instance}.xano.io/api:meta
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Xano Workspace API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Scoped Metadata API access token generated from your Xano instance settings (Instances Metadata API Manage Access Tokens). Sent as Authorization: Bearer .

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workspace 6

Workspace details, branches, import/export.

GET
/workspace
List workspaces accessible to the token.
listWorkspaces → 200401
GET
/workspace/{workspace_id}
Retrieve workspace details.
getWorkspace 1 param → 200404
GET
/workspace/{workspace_id}/branch
List branches in the workspace.
listBranches 1 param → 200
DELETE
/workspace/{workspace_id}/branch/{branch_id}
Delete a branch.
deleteBranch 2 params → 200404
POST
/workspace/{workspace_id}/export-schema
Export the workspace schema.
exportWorkspaceSchema 1 param → 200
POST
/workspace/{workspace_id}/export
Export the workspace schema and data as an archive.
exportWorkspace 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), Branch (3 properties), Workspace (3 properties). Each schema is shown below with its type and property counts.

Workspace
object
3 properties
Branch
object
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xano-workspace-api-openapi.yml Raw ↑

Other APIs Xano publishes across the network.

Xano Generated User APIs
Xano API Groups API
Xano Auth API
Xano Content API
Xano Files API
Xano Tables API