Skip to main content
The Metadata API is in beta and is subject to changes including access.
The Metadata API (Beta) enables you to interact with your Xano workspace schema and content programmatically. The Metadata API includes a comprehensive collection of API endpoints designed to add and modify database tables, schemas, and more. The Metadata API is also used in some cases to facilitate an integration with Xano by providing the integration partner with your Metadata API access token.

​
Getting Started with the Metadata API

​
Generate an Access Token

An access token is required for any request you send to the Metadata API.

​
Before you proceed

Generating an access token requires giving it specific permissions regarding what it can access. Make sure to review available scopes before proceeding. Token Scopes Reference
1

Click the profile icon in the lower-left corner and choose Instances

2

Click ⚙️ next to your instance and choose Metadata API from the panel that opens

3

Click 'Manage Access Tokens'

4

Click 'New Access Token'

5

Give your access token a name

Access tokens can have different scopes, or permissions, defined. Giving each access token a recognizable name is important for you to quickly recognize which access tokens are created for specific purposes.
6

Select the expiry for your access token

By default, Xano will revoke your Metadata API access token after 7 days, which means if you need to access the API again, you would have to generate a new token.You can choose your own expiry duration; anything from 1 hour to never expire.
Use caution when defining extended expiry or setting tokens to never expire. Token rotation is good security practice.You can always revoke a token at any time.
7

Define the scopes for your token

The scopes tell Xano what this token has access to. Each scope has 4 options:C (Create) - Determines whether or not this token can create new dataR (Read) - Determines whether or not this token can read existing dataU (Update) - Determines whether or not this token can update existing dataD (Delete) - Determines whether or not this token can delete data.
HintYou can hover over each permission to quickly add or remove all four types of scope.
Each scope has their own API endpoints associated with them. If you aren’t sure which scopes you need for this token, use the reference below for additional information.
ScopeDescription
DatabaseAccess any of the content in your Xano database
ContentAccess any content outside of the database or function stacks, such as branches, data sources, and realtime
Live Data SourceAccess the data inside of your currently live data source
API GroupsAccess API Groups and APIs
FunctionsAccess custom functions
AddonsAccess addons
TaskAccess background tasks
FilesAccess file storage
Request HistoryAccess request history
8

Once you've set up your token, click button to copy it to your clipboard.

You will be shown your new access token. Click the button to copy it to your clipboard.
You will only be shown this token once, so make sure to copy it and store it in a safe place.If you lose the token, you should revoke it and create a new one.

​
Using your Access Token in Requests

The token should be sent as a header in the following format: 
Authorization: Bearer your_token_here

​
Revoking an Access Token

When you access the metadata API panel, you can review all of your currently issued tokens and their scopes. By choosing a token and clicking you can immediately revoke that token from use.

​
The Account API

The Account API allows you access to various settings and information about your Xano account.
Please use extreme caution when sharing your Metadata API access tokens, as they can provide access to all of your Xano data.

​
Account API Endpoints

​
Validate the Access Token and identify the account details.

gethttps://app.xano.com/api:meta/auth/meValidate the Access Token and identify the account details. Authentication: requiredAuthorizationsResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/auth/meHTTP
GET /api:meta/auth/me HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": "text",
  "name": "text",
  "email": "text",
  "extras": "text"
}

​
browse instances

gethttps://app.xano.com/api:meta/instancebrowse instances Authentication: requiredAuthorizationsResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/instanceHTTP
GET /api:meta/instance HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "name": "x1234-4567-8901",
    "display": "My Instance",
    "xano_domain": "x1234-4567-8901.n7.xano.com",
    "custom_domain": "text",
    "rate_limit": true,
    "meta_api": "https://x1234-4567-8901.n7.xano.com/api:meta",
    "meta_swagger": "https://x1234-4567-8901.n7.xano.com/apispec:meta?type=json"
  }
]

​
get instance

gethttps://app.xano.com/api:meta/instance/{name}get instance Authentication: requiredAuthorizationsPath parametersnamestringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/instance/{name}HTTP
GET /api:meta/instance/{name} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "name": "x1234-4567-8901",
  "display": "My Instance",
  "xano_domain": "x1234-4567-8901.n7.xano.com",
  "custom_domain": "text",
  "rate_limit": true,
  "meta_api": "https://x1234-4567-8901.n7.xano.com/api:meta",
  "meta_swagger": "https://x1234-4567-8901.n7.xano.com/apispec:meta?type=json"
}

​
browse instances

gethttps://app.xano.com/api:meta/instancebrowse instances Authentication: requiredAuthorizationsResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/instanceHTTP
GET /api:meta/instance HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "name": "x1234-4567-8901",
    "display": "My Instance",
    "xano_domain": "x1234-4567-8901.n7.xano.com",
    "custom_domain": "text",
    "rate_limit": true,
    "meta_api": "https://x1234-4567-8901.n7.xano.com/api:meta",
    "meta_swagger": "https://x1234-4567-8901.n7.xano.com/apispec:meta?type=json"
  }
]

​
list snippets owned by the authenticated user

gethttps://app.xano.com/api:meta/snippetlist snippets owned by the authenticated user Authentication: requiredAuthorizationsQuery parameterspageinteger · int64OptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/snippetHTTP
GET /api:meta/snippet HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "canonical": "kRG3t_-i",
      "created_at": "2023-03-23 23:32:56+0000",
      "updated_at": "2023-03-27 17:58:48+0000",
      "name": "Token Share Test",
      "review": "pending",
      "review_exception": "text",
      "install_access": "public",
      "install_access_description": "text",
      "featured": true,
      "verified": true
    }
  ]
}

​
update settings on the snippet

posthttps://app.xano.com/api:meta/snippet/{canonical}update settings on the snippet Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredBodyapplication/jsoninstall_accessstring · enumRequiredPossible values: public``link``tokeninstall_access_descriptionstringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/snippet/{canonical}HTTP
POST /api:meta/snippet/{canonical} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "install_access": "public",
  "install_access_description": "text"
}
application/jsonTest it200Success!
{
  "canonical": "kRG3t_-i",
  "created_at": "2023-03-23 23:32:56+0000",
  "updated_at": "2023-03-27 17:58:48+0000",
  "name": "Token Share Test",
  "review": "pending",
  "review_exception": "text",
  "install_access": "public",
  "install_access_description": "text",
  "featured": true,
  "verified": true
}

​
get a specific snippet by ID

gethttps://app.xano.com/api:meta/snippet/{canonical}get a specific snippet by ID Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/snippet/{canonical}HTTP
GET /api:meta/snippet/{canonical} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "canonical": "kRG3t_-i",
  "created_at": "2023-03-23 23:32:56+0000",
  "updated_at": "2023-03-27 17:58:48+0000",
  "name": "Token Share Test",
  "review": "pending",
  "review_exception": "text",
  "install_access": "public",
  "install_access_description": "text",
  "featured": true,
  "verified": true
}

​
creates a new install token on the snippet

posthttps://app.xano.com/api:meta/snippet/{canonical}/tokencreates a new install token on the snippet Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredBodyapplication/jsonmax_installsinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/snippet/{canonical}/tokenHTTP
POST /api:meta/snippet/{canonical}/token HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "max_installs": 1
}
application/jsonTest it200Success!
{
  "created_at": "2023-05-09 21:31:20+0000",
  "updated_at": "2023-05-09 21:31:20+0000",
  "token": "OL3T4JYM",
  "max_installs": 23,
  "current_installs": 1
}

​
returns a list of tokens for a snippet

gethttps://app.xano.com/api:meta/snippet/{canonical}/tokenreturns a list of tokens for a snippet Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/snippet/{canonical}/tokenHTTP
GET /api:meta/snippet/{canonical}/token HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "created_at": "2023-05-09 21:31:20+0000",
    "updated_at": "2023-05-09 21:31:20+0000",
    "token": "OL3T4JYM",
    "max_installs": 23,
    "current_installs": 1
  }
]

​
updates a snippet token

posthttps://app.xano.com/api:meta/snippet/{canonical}/token/{token}updates a snippet token Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredtokenstringRequiredBodyapplication/jsonmax_installsinteger · int64Requiredcurrent_installsinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/snippet/{canonical}/token/{token}HTTP
POST /api:meta/snippet/{canonical}/token/{token} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "max_installs": 1,
  "current_installs": 1
}
application/jsonTest it200Success!
{
  "created_at": "2023-05-09 21:31:20+0000",
  "updated_at": "2023-05-09 21:31:20+0000",
  "token": "OL3T4JYM",
  "max_installs": 23,
  "current_installs": 1
}

​
deletes a snippet token

deletehttps://app.xano.com/api:meta/snippet/{canonical}/token/{token}deletes a snippet token Authentication: requiredAuthorizationsPath parameterscanonicalstringRequiredtokenstringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/snippet/{canonical}/token/{token}HTTP
DELETE /api:meta/snippet/{canonical}/token/{token} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
The Instance API

The Instance API allows you to access data inside of your Xano instances, such as your database, files, and function stacks.

​
get workspace API group

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}get workspace API group Authentication: required Required API Scope: Workspace Api: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/apigroup/{apigroup_id}HTTP
GET /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Group Test",
  "description": "My API groups description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "canonical": "FRzyRdY0",
  "branch": "v1",
  "tag": [
    "text"
  ]
}

​
add workspace API group

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroupadd workspace API group Authentication: required Required API Scope: Workspace Api: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonbranchstringOptionalnamestringRequireddescriptionstringRequireddocsstringOptionalswaggerbooleanRequiredtagstring[] | nullableOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/apigroupHTTP
POST /api:meta/workspace/{workspace_id}/apigroup HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "branch": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "swagger": true,
  "tag": [
    "text"
  ]
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Group Test",
  "description": "My API groups description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "canonical": "FRzyRdY0",
  "branch": "v1",
  "tag": [
    "text"
  ]
}

​
delete workspace API group

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}delete workspace API group Authentication: required Required API Scope: Workspace Api: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/apigroup/{apigroup_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update workspace API group

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}update workspace API group Authentication: required Required API Scope: Workspace Api: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringRequireddocsstringOptionalswaggerbooleanRequiredtagstring[] | nullableOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/apigroup/{apigroup_id}HTTP
PUT /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "name": "text",
  "description": "text",
  "docs": "text",
  "swagger": true,
  "tag": [
    "text"
  ]
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Group Test",
  "description": "My API groups description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "canonical": "FRzyRdY0",
  "branch": "v1",
  "tag": [
    "text"
  ]
}

​
browse workspace API groups

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroupbrowse workspace API groups Authentication: required Required API Scope: Workspace Api: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredQuery parametersbranchstringOptionalpageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalsortstring · enumOptionalPossible values: created_at``updated_at``nameorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/apigroupHTTP
GET /api:meta/workspace/{workspace_id}/apigroup HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "2023-04-19 21:01:32+0000",
      "updated_at": "2023-04-19 21:01:32+0000",
      "name": "API Group Test",
      "description": "My API groups description",
      "docs": "Documentation",
      "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
      "canonical": "FRzyRdY0",
      "branch": "v1",
      "tag": [
        "text"
      ]
    }
  ]
}

​
update workspace API group security settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/securityupdate workspace API group security settings Authentication: required Required API Scope: Workspace Api: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredBodyapplication/jsonguidstringRequiredcanonicalstringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/apigroup/{apigroup_id}/securityHTTP
PUT /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "guid": "text",
  "canonical": "text"
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Group Test",
  "description": "My API groups description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "canonical": "FRzyRdY0",
  "branch": "v1",
  "tag": [
    "text"
  ]
}

​
browse API’s in an API group

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/apibrowse API’s in an API group Authentication: required Required API Scope: Workspace Api: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredQuery parameterspageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalsortstring · enumOptionalPossible values: created_at``updated_at``nameorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/apigroup/{apigroup_id}/apiHTTP
GET /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "2023-04-19 21:01:32+0000",
      "updated_at": "2023-04-19 21:01:32+0000",
      "name": "API Test",
      "description": "My APIs description",
      "docs": "Documentation",
      "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
      "cache": {
        "active": true,
        "ttl": 3600,
        "input": true,
        "auth": true,
        "datasource": true,
        "ip": true,
        "headers": [
          "text"
        ],
        "env": [
          "text"
        ]
      },
      "auth": {},
      "verb": "GET",
      "input": [
        {}
      ],
      "tag": [
        "text"
      ]
    }
  ]
}

​
get workspace API

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}get workspace API Authentication: required Required API Scope: Workspace Api: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64Requiredapi_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}HTTP
GET /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Test",
  "description": "My APIs description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  },
  "auth": {},
  "verb": "GET",
  "input": [
    {}
  ],
  "tag": [
    "text"
  ]
}

​
delete workspace API

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}delete workspace API Authentication: required Required API Scope: Workspace Api: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64Requiredapi_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update workspace api

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}update workspace api Authentication: required Required API Scope: Workspace Api: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64Requiredapi_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringRequireddocsstringOptionalverbstring · enumRequiredPossible values: GET``POST``DELETE``PUT``PATCH``HEADauthobjectOptionaltagstring[] | nullableOptionalcacheobjectOptionalShow propertiesResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}HTTP
PUT /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "name": "text",
  "description": "text",
  "docs": "text",
  "verb": "GET",
  "auth": {},
  "tag": [
    "text"
  ],
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}
application/jsonTest it200Success!
{}

​
add workspace API

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/apiadd workspace API Authentication: required Required API Scope: Workspace Api: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringRequireddocsstringOptionalverbstring · enumRequiredPossible values: GET``POST``DELETE``PUT``PATCH``HEADtagstring[] | nullableOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/apigroup/{apigroup_id}/apiHTTP
POST /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "description": "text",
  "docs": "text",
  "verb": "GET",
  "tag": [
    "text"
  ]
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Test",
  "description": "My APIs description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  },
  "auth": {},
  "verb": "GET",
  "input": [
    {}
  ],
  "tag": [
    "text"
  ]
}

​
update workspace api security settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/securityupdate workspace api security settings Authentication: required Required API Scope: Workspace Api: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredapigroup_idinteger · int64Requiredapi_idinteger · int64RequiredBodyapplication/jsonguidstringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/securityHTTP
PUT /api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/security HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "guid": "text"
}
application/jsonTest it200Success!
{}

​
delete a workspace branch

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/branch/{branch_label}delete a workspace branch Authentication: required Required API Scope: Instance Workspace: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredbranch_labelstringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/branch/{branch_label}HTTP
DELETE /api:meta/workspace/{workspace_id}/branch/{branch_label} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
browse workspace branches

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/branchbrowse workspace branches Authentication: required Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/branchHTTP
GET /api:meta/workspace/{workspace_id}/branch HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "created_at": "2023-06-22 22:59:11+0000",
    "label": "v1",
    "live": true,
    "backup": "false"
  }
]

​
delete workspace data source

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource/{label}delete workspace data source Authentication: required Required API Scope: Instance Workspace: DeleteAuthorizationsPath parametersworkspace_idinteger · int64RequiredlabelstringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/datasource/{label}HTTP
DELETE /api:meta/workspace/{workspace_id}/datasource/{label} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update workspace data source

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource/{label}update workspace data source Authentication: required Required API Scope: Instance Workspace: UpdateAuthorizationsPath parametersworkspace_idinteger · int64RequiredlabelstringRequiredBodyapplication/jsoncolorstringOptionalDefault: #ebc346Responses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/datasource/{label}HTTP
PUT /api:meta/workspace/{workspace_id}/datasource/{label} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "color": "#ebc346"
}
application/jsonTest it200Success!
{
  "color": "#008000",
  "label": "live"
}

​
browse workspace data sources

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasourcebrowse workspace data sources Authentication: required Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/datasourceHTTP
GET /api:meta/workspace/{workspace_id}/datasource HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "color": "#008000",
    "label": "live"
  }
]

​
create workspace data source

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasourcecreate workspace data source Authentication: required Required API Scope: Instance Workspace: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonlabelstringRequiredcolorstringOptionalDefault: #ebc346Responses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/datasourceHTTP
POST /api:meta/workspace/{workspace_id}/datasource HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "label": "text",
  "color": "#ebc346"
}
application/jsonTest it200Success!
{
  "color": "#008000",
  "label": "live"
}

​
export the database table + branch schema

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/export-schemaLeave the branch parameter empty to indicate the current live branch. password is optional. If provided, will encrypt the export and will be required when importing the file. Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonpasswordstringOptionalbranchstringOptionalResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/export-schemaHTTP
POST /api:meta/workspace/{workspace_id}/export-schema HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "branch": "",
  "password": ""
}
application/jsonTest it200Success!
{}

​
export the workspace and content

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/exportLeave the branch parameter empty to indicate the current live branch. password is optional. If provided, will encrypt the export and will be required when importing the file. Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonpasswordstringOptionalbranchstringOptionalResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/exportHTTP
POST /api:meta/workspace/{workspace_id}/export HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "branch": "",
  "password": ""
}
application/jsonTest it200Success!
{}

​
browse workspaces

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspacebrowse workspaces Authentication: requiredAuthorizationsResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspaceHTTP
GET /api:meta/workspace HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "id": 1,
    "name": "My Workspace",
    "description": "My Workspace Description",
    "branch": "v1"
  }
]

​
browse workspace

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}browse workspace Authentication: required Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}HTTP
GET /api:meta/workspace/{workspace_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": 1,
  "name": "My Workspace",
  "description": "My Workspace Description",
  "branch": "v1"
}

​
update workspace table’s autocomplete

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/autocompleteupdate workspace table’s autocomplete Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonautocompleteobject[]OptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/autocompleteHTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/autocomplete HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "autocomplete": [
    {
      "name": "id"
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text",
  "autocomplete": "text"
}

​
delete table content rows in bulk

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/deleteThe request body should contain an array of row_ids, where each id identifies a row to be deleted. Required API Scope: Workspace Content: DeleteAuthorizationsPath parametersworkspace_idstringRequiredtable_idstringRequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonrow_idsstring[]OptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/bulk/deleteHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/delete HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "row_ids": [
    1
  ]
}
application/jsonTest it200Success!
{
  "success": [
    "text"
  ],
  "success_total": 1,
  "error": [
    "text"
  ]
}

​
update table content in bulk

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/patchThe request body should contain an array of items, where each item represents a row to be updated. For each row, provide the row_id and updates array that specifies the columns (path) to update and the new values (value). The example below is assuming that the table being modified has a column labeled name.Required API Scope: Workspace Content: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonitemsobject[]OptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/bulk/patchHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/patch HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "items": [
    {
      "row_id": 1,
      "updates": {
        "name": "test name"
      }
    }
  ]
}
application/jsonTest it200Success!
{
  "success": [
    "text"
  ],
  "success_total": 1
}

​
create new table content in bulk

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulkEach table has unique schema, which means that the request body should be an array of objects with the schema relevant to the table being used. The example below is assuming that the table has a column labeled “name”.Required API Scope: Workspace Content: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonallow_id_fieldbooleanOptionalitemsobjectRequiredResponses200Success!application/jsonResponseinteger · int64[]400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/bulkHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "items": [
    {
      "name": "test name"
    }
  ],
  "allow_id_field": false
}
application/jsonTest it200Success!
[
  1
]

​
delete table content rows matching search criteria

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/search/deleteProvide search criteria to delete all matching rows. Required API Scope: Workspace Content: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonsearchobjectOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/search/deleteHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/search/delete HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "search": []
}
application/jsonTest it200Success!
{
  "success": [
    "text"
  ],
  "success_total": 1
}

​
patch table content rows matching search criteria

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/search/patchProvide search and update objects with path and new value to patch rows matching search criteria. Required API Scope: Workspace Content: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonsearchobjectOptionalupdatesobjectOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/search/patchHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/search/patch HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "search": [
    {
      "name": "test"
    }
  ],
  "updates": {
    "name": "new name"
  }
}
application/jsonTest it200Success!
{
  "success": [
    "text"
  ],
  "success_total": 1
}

​
search table content with support for complex filtering and sorting

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/searchsearch table content with support for complex filtering and sorting Authentication: required Required API Scope: Workspace Content: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonpageinteger · int64OptionalDefault: 1per_pageinteger · int64OptionalDefault: 50sortobjectOptionalsearchobjectOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/content/searchHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content/search HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "page": 1,
  "per_page": 50,
  "sort": {
    "id": "desc"
  },
  "search": []
}
application/jsonTest it200Success!
{
  "items": {},
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

​
delete table content

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}delete table content Authentication: required Required API Scope: Workspace Content: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredcontent_idstringRequiredHeader parametersx-data-sourcestringOptionalDefault: liveResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/table/{table_id}/content/{content_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
get table content

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}get table content Authentication: required Required API Scope: Workspace Content: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredcontent_idstringRequiredHeader parametersx-data-sourcestringOptionalDefault: liveResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}/content/{content_id}HTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update existing table content

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}Each table has unique schema, which means that the request body should be updated with the schema relevant to the table being used. The example below is assuming that the table has a column labeled “name”.Required API Scope: Workspace Content: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredcontent_idstringRequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyobjectOptionalExample: {"name":"test name"}Responses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/content/{content_id}HTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "name": "test name"
}
Test it200Success!
{}

​
browse table content

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/contentbrowse table content Authentication: required Required API Scope: Workspace Content: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredQuery parameterspageinteger · int64Optionalper_pageinteger · int64OptionalHeader parametersx-data-sourcestringOptionalDefault: liveResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}/contentHTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id}/content HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "items": {},
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

​
create new table content

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/contentEach table has unique schema, which means that the request body should be updated with the schema relevant to the table being used. The example below is assuming that the table has a column labeled “name”.Required API Scope: Workspace Content: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyobjectOptionalExample: {"name":"test name"}Responses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/contentHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/content HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "name": "test name"
}
Test it200Success!
{}

​
create a btree table index

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/btreecreate a btree table index Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonfieldsobject[]RequiredShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/index/btreeHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/index/btree HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "fields": [
    {
      "name": "name",
      "op": "desc"
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
create a search table index

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/searchcreate a search table index Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequiredlangstring · enumRequiredPossible values: simple``arabic``danish``dutch``english``finnish``french``german``hungarian``indonesian``irish``italian``lithuanian``nepali``norwegian``portuguese``romanian``russian``spanish``swedish``tamil``turkishfieldsobject[]RequiredShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/index/searchHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/index/search HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "name": "search_label",
  "lang": "english",
  "fields": [
    {
      "name": "name",
      "priority": 1
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
create a spatial table index

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/spatialcreate a spatial table index Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonfieldsobject[]RequiredShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/index/spatialHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/index/spatial HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "fields": [
    {
      "name": "location",
      "op": "gist_geometry_ops_2d"
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
create a unique table index

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/uniquecreate a unique table index Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonfieldsobject[]RequiredShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/index/uniqueHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/index/unique HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "fields": [
    {
      "name": "name",
      "op": "desc"
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
create a vector table index

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/vectorOptions include vector_ip_ops (Inner Product), vector_cosine_ops (Cosine), vector_l1_ops (L1 Distance), vector_l2_ops (L2 Distance) Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonfieldsobject[]RequiredShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/index/vectorHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/index/vector HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "fields": [
    {
      "name": "name",
      "op": "vector_ip_ops"
    }
  ]
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
delete table index

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/{index_id}delete table index Authentication: required Required API Scope: Workspace Database: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredindex_idstringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/table/{table_id}/index/{index_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/table/{table_id}/index/{index_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
browse table indexes

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/indexbrowse table indexes Authentication: required Required API Scope: Workspace Database: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}/indexHTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id}/index HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
replace all of the indexes of a workspace table

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/indexreplace all of the indexes of a workspace table Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonindexobjectRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/indexHTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/index HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "index": [
    {
      "type": "primary",
      "fields": [
        {
          "name": "id"
        }
      ]
    },
    {
      "type": "btree",
      "fields": [
        {
          "name": "created_at",
          "op": "desc"
        }
      ]
    }
  ]
}
application/jsonTest it200Success!
{}

​
update workspace table’s metadata

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/metaupdate workspace table’s metadata Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestring | nullableOptionaldescriptionstring | nullableOptionaltagstring[] | nullableOptionalauthboolean | nullableOptionalResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/metaHTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/meta HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "name": "text",
  "description": "text",
  "tag": [
    "text"
  ],
  "auth": true
}
application/jsonTest it200Success!
{}

​
rename a column within the schema of a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/renamerename a column within the schema of a workspace table Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnew_namestringRequiredold_namestringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/renameHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/rename HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "new_name": "new_field",
  "old_name": "old_field"
}
application/jsonTest it200Success!
{}

​
create attachment schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/attachmentcreate attachment schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/attachmentHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/attachment HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "name": "attachment"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create audio schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/audiocreate audio schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/audioHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/audio HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "audio"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create bool schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/boolcreate bool schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultbooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/boolHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/bool HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "finished",
  "default": false
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create date schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/datecreate date schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/dateHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/date HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "name": "completed_at"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create decimal schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/decimalcreate decimal schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultnumberOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listfiltersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/decimalHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/decimal HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "score",
  "default": 100
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create email schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/emailcreate email schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultstringOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/emailHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/email HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "email"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create enum schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/enumcreate enum schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultstringOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listvaluesstring[]OptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/enumHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/enum HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "name": "status",
  "values": [
    "To Do",
    "In Progress",
    "Done",
    "Pending"
  ]
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_linestring schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_linestringcreate geo_linestring schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_linestringHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_linestring HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "line"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_multilinestring schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multilinestringcreate geo_multilinestring schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multilinestringHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multilinestring HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "lines"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_multipoint schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipointcreate geo_multipoint schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipointHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipoint HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "name": "points"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_multipolygon schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipolygoncreate geo_multipolygon schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipolygonHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipolygon HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "polygons"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_point schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_pointcreate geo_point schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_pointHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_point HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "point"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create geo_polygon schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_polygoncreate geo_polygon schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalsensitivebooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/geo_polygonHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_polygon HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "polygon"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create image schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/imagecreate image schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/imageHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/image HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "image"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create int schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/intcreate int schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultinteger · int64OptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listfiltersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/intHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/int HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "score",
  "default": 100
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create json schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/jsoncreate json schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/jsonHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/json HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "data"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create object schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/objectcreate object schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listchildrenobjectOptionalResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/objectHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/object HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "name": "group",
  "children": [
    {
      "name": "name",
      "type": "text"
    },
    {
      "name": "score",
      "type": "int"
    }
  ]
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create password reference schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/passwordcreate password reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listfiltersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/passwordHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/password HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "name": "password",
  "filters": {
    "min": 8,
    "max": 64,
    "minAlpha": 1,
    "minDigit": 1,
    "minSymbol": 1
  }
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create table reference schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefuuidcreate table reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionaltableref_idinteger · int64RequirednullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefuuidHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefuuid HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "user_id",
  "tableref_id": 101
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create table reference schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefcreate table reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionaltableref_idinteger · int64RequirednullablebooleanOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listfiltersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tableref HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "user_id",
  "tableref_id": 101
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create text schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/textcreate text schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultstringOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listformatstring · enumOptionalPossible values: ```plaintextyamlhtmlxmlmarkdown`filtersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/textHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/text HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "name": "name",
  "filters": {
    "trim": true,
    "max": 100
  }
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create timestamp schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/timestampcreate timestamp schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/timestampHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/timestamp HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "name": "completed_at"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create uuid schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/uuidcreate uuid schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultinteger · int64OptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/uuidHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/uuid HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "user_id"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create vector schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/vectorcreate vector schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionaldefaultstringOptionalrequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listvectorobjectRequiredShow propertiesfiltersobject | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/vectorHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/vector HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "name",
  "vector": {
    "size": 3
  }
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
create video schema within a workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/videocreate video schema within a workspace table Authentication: required Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionalnullablebooleanOptionalDefault: truerequiredbooleanOptionalaccessstring · enumOptionalDefault: publicPossible values: public``private``internalsensitivebooleanOptionalstylestring · enumOptionalDefault: singlePossible values: single``listResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/table/{table_id}/schema/type/videoHTTP
POST /api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/video HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "name": "video"
}
application/jsonTest it200Success!
{
  "name": "text"
}

​
delete a specific schema element within workspace table

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}delete a specific schema element within workspace table Authentication: required Required API Scope: Workspace Database: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredschema_namestringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}HTTP
DELETE /api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
get a specific schema element within workspace table

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}get a specific schema element within workspace table Authentication: required Required API Scope: Workspace Database: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64Requiredschema_namestringRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}HTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
browse workspace table’s schema

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schemabrowse workspace table’s schema Authentication: required Required API Scope: Workspace Database: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}/schemaHTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id}/schema HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
replace the entire schema of a workspace table

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schemareplace the entire schema of a workspace table Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonschemaobjectRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/schemaHTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/schema HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 458

{
  "schema": [
    {
      "name": "id",
      "type": "int",
      "description": "",
      "nullable": false,
      "default": "",
      "required": true,
      "access": "public",
      "sensitive": false,
      "style": "single"
    },
    {
      "name": "created_at",
      "type": "timestamp",
      "description": "",
      "nullable": false,
      "default": "",
      "required": true,
      "access": "public",
      "sensitive": false,
      "style": "single"
    },
    {
      "name": "name",
      "type": "text",
      "description": "",
      "nullable": false,
      "default": "",
      "required": true,
      "access": "public",
      "sensitive": false,
      "style": "single"
    }
  ]
}
application/jsonTest it200Success!
{}

​
update workspace table’s security settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/securityupdate workspace table’s security settings Authentication: required Required API Scope: Workspace Database: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredBodyapplication/jsonguidstring | nullableOptionalResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/table/{table_id}/securityHTTP
PUT /api:meta/workspace/{workspace_id}/table/{table_id}/security HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "guid": "text"
}
application/jsonTest it200Success!
{}

​
truncate table’s content and optionally reset the primary key

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/truncatetruncate table’s content and optionally reset the primary key Authentication: required Required API Scope: Workspace Content: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredHeader parametersx-data-sourcestringOptionalDefault: liveBodyapplication/jsonresetbooleanRequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/table/{table_id}/truncateHTTP
DELETE /api:meta/workspace/{workspace_id}/table/{table_id}/truncate HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "reset": true
}
application/jsonTest it200Success!
{}

​
delete workspace table and all of its content

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}delete workspace table and all of its content Authentication: required Required API Scope: Workspace Database: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/table/{table_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/table/{table_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
get workspace table

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}get workspace table Authentication: required Required API Scope: Workspace Database: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtable_idinteger · int64RequiredResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/table/{table_id}HTTP
GET /api:meta/workspace/{workspace_id}/table/{table_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "id": 1,
    "created_at": "2023-04-19 21:01:32+0000",
    "updated_at": "2023-04-19 21:01:32+0000",
    "name": "Test Database",
    "description": "My test database description",
    "docs": "Documentation",
    "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
    "auth": true,
    "tag": [
      "text"
    ]
  }
]

​
browse workspace tables

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/tablebrowse workspace tables Authentication: required Required API Scope: Workspace Database: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredQuery parameterspageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalsortstring · enumOptionalPossible values: created_at``updated_at``nameorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobject[]Show properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/tableHTTP
GET /api:meta/workspace/{workspace_id}/table HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
[
  {
    "curPage": 1,
    "nextPage": 1,
    "prevPage": 1,
    "items": [
      {
        "id": 1,
        "created_at": "2023-04-19 21:01:32+0000",
        "updated_at": "2023-04-19 21:01:32+0000",
        "name": "Test Database",
        "description": "My test database description",
        "docs": "Documentation",
        "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
        "auth": true,
        "tag": [
          "text"
        ]
      }
    ]
  }
]

​
create workspace table

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/tableThis endpoint can create a complete table in a single API request, as long as all values below are fully fleshed out. If you want to create the table in multiple steps, then just fill out the name field as shown in the example. Required API Scope: Workspace Database: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringOptionaldocsstringOptionalauthbooleanOptionalguidstring | nullableOptionalschemaobject | nullableOptionalindexobject | nullableOptionaltagstring[] | nullableOptionalautocompleteobject[] | nullableOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/tableHTTP
POST /api:meta/workspace/{workspace_id}/table HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "name": "new table 123",
  "description": "",
  "docs": "",
  "auth": null,
  "guid": null,
  "schema": null,
  "index": null,
  "autocomplete": [],
  "tag": []
}
application/jsonTest it200Success!
{
  "id": "text"
}

​
get workspace function

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}get workspace function Authentication: required Required API Scope: Workspace Function: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredfunction_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/function/{function_id}HTTP
GET /api:meta/workspace/{workspace_id}/function/{function_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Function Test",
  "description": "My functions description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "branch": "v1",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

​
add workspace function

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/functionadd workspace function Authentication: required Required API Scope: Workspace Function: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonbranchstringOptionaldescriptionstringRequireddocsstringOptionalnamestringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/functionHTTP
POST /api:meta/workspace/{workspace_id}/function HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "branch": "text",
  "description": "text",
  "docs": "text",
  "name": "text"
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Function Test",
  "description": "My functions description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "branch": "v1",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

​
delete workspace function

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}delete workspace function Authentication: required Required API Scope: Workspace Function: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredfunction_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/function/{function_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/function/{function_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update workspace function

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}update workspace function Authentication: required Required API Scope: Workspace Function: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredfunction_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringRequireddocsstringOptionalcacheobjectOptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/function/{function_id}HTTP
PUT /api:meta/workspace/{workspace_id}/function/{function_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "name": "text",
  "description": "text",
  "docs": "text",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Function Test",
  "description": "My functions description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "branch": "v1",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

​
browse workspace functions

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/functionbrowse workspace functions Authentication: required Required API Scope: Workspace Function: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredQuery parametersbranchstringOptionalpageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalsortstring · enumOptionalPossible values: created_at``updated_at``nameorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/functionHTTP
GET /api:meta/workspace/{workspace_id}/function HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "2023-04-19 21:01:32+0000",
      "updated_at": "2023-04-19 21:01:32+0000",
      "name": "Function Test",
      "description": "My functions description",
      "docs": "Documentation",
      "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
      "branch": "v1",
      "cache": {
        "active": true,
        "ttl": 3600,
        "input": true,
        "auth": true,
        "datasource": true,
        "ip": true,
        "headers": [
          "text"
        ],
        "env": [
          "text"
        ]
      }
    }
  ]
}

​
update workspace function security settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}/securityupdate workspace function security settings Authentication: required Required API Scope: Workspace Function: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredfunction_idinteger · int64RequiredBodyapplication/jsonguidstringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/function/{function_id}/securityHTTP
PUT /api:meta/workspace/{workspace_id}/function/{function_id}/security HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "guid": "text"
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Function Test",
  "description": "My functions description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "branch": "v1",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

​
get workspace task

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}get workspace task Authentication: required Required API Scope: Workspace Task: ReadAuthorizationsPath parametersworkspace_idinteger · int64Requiredtask_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/task/{task_id}HTTP
GET /api:meta/workspace/{workspace_id}/task/{task_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Task Test",
  "description": "My tasks description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "datasource": "test",
  "active": true,
  "branch": "v1"
}

​
add workspace task

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/taskadd workspace task Authentication: required Required API Scope: Workspace Task: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonbranchstringOptionalnamestringRequireddescriptionstringRequireddocsstringOptionaldatasourcestringRequiredactivebooleanRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/taskHTTP
POST /api:meta/workspace/{workspace_id}/task HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "branch": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "datasource": "text",
  "active": true
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Task Test",
  "description": "My tasks description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "datasource": "test",
  "active": true,
  "branch": "v1"
}

​
delete workspace task

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}delete workspace task Authentication: required Required API Scope: Workspace Task: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredtask_idinteger · int64RequiredResponses200Success!application/jsonResponseobject400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/task/{task_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/task/{task_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{}

​
update workspace task

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}update workspace task Authentication: required Required API Scope: Workspace Task: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtask_idinteger · int64RequiredBodyapplication/jsonnamestringRequireddescriptionstringRequireddocsstringOptionaldatasourcestringRequiredactivebooleanRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/task/{task_id}HTTP
PUT /api:meta/workspace/{workspace_id}/task/{task_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "description": "text",
  "docs": "text",
  "datasource": "text",
  "active": true
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Task Test",
  "description": "My tasks description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "datasource": "test",
  "active": true,
  "branch": "v1"
}

​
browse workspace tasks

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/taskbrowse workspace tasks Authentication: required Required API Scope: Workspace Task: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredQuery parametersbranchstringOptionalpageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalsortstring · enumOptionalPossible values: created_at``updated_at``nameorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/taskHTTP
GET /api:meta/workspace/{workspace_id}/task HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "2023-04-19 21:01:32+0000",
      "updated_at": "2023-04-19 21:01:32+0000",
      "name": "Task Test",
      "description": "My tasks description",
      "docs": "Documentation",
      "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
      "datasource": "test",
      "active": true,
      "branch": "v1"
    }
  ]
}

​
update workspace task security settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}/securityupdate workspace task security settings Authentication: required Required API Scope: Workspace Task: UpdateAuthorizationsPath parametersworkspace_idinteger · int64Requiredtask_idinteger · int64RequiredBodyapplication/jsonguidstringRequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/task/{task_id}/securityHTTP
PUT /api:meta/workspace/{workspace_id}/task/{task_id}/security HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "guid": "text"
}
application/jsonTest it200Success!
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "Task Test",
  "description": "My tasks description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "datasource": "test",
  "active": true,
  "branch": "v1"
}

​
list files within workspace

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/filelist files within workspace Authentication: required Required API Scope: Workspace File: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredQuery parameterspageinteger · int64Optionalper_pageinteger · int64OptionalsearchstringOptionalaccessstring · enumOptionalPossible values: public``privatesortstring · enumOptionalPossible values: created_at``name``size``mimeorderstring · enumOptionalPossible values: asc``descResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/fileHTTP
GET /api:meta/workspace/{workspace_id}/file HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 10095,
      "created_at": "2023-04-19 21:01:32+0000",
      "name": "file_example_MP3_1MG.mp3",
      "size": 1087849,
      "type": "audio",
      "mime": "audio/mpeg",
      "access": "public",
      "path": "/vault/Ramtdv50/3TA6XKsmLe-2BigGnwxSb0v00sI/qSWtbg../file_example_MP3_1MG.mp3"
    }
  ]
}

​
upload file to workspace

posthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/fileupload file to workspace Authentication: required Required API Scope: Workspace File: CreateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodycontentstring · binaryRequiredtypestring · enumOptionalPossible values: image``video``audioaccessstring · enumOptionalDefault: publicPossible values: public``privateResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorpost/workspace/{workspace_id}/fileHTTP
POST /api:meta/workspace/{workspace_id}/file HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 53

{
  "content": "binary",
  "type": "image",
  "access": "public"
}
Test it200Success!
{
  "id": 10095,
  "created_at": "2023-04-19 21:01:32+0000",
  "name": "file_example_MP3_1MG.mp3",
  "size": 1087849,
  "type": "audio",
  "mime": "audio/mpeg",
  "access": "public",
  "path": "/vault/Ramtdv50/3TA6XKsmLe-2BigGnwxSb0v00sI/qSWtbg../file_example_MP3_1MG.mp3"
}

​
delete file within workspace

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file/{file_id}delete file within workspace Authentication: required Required API Scope: Workspace File: DeleteAuthorizationsPath parametersworkspace_idinteger · int64Requiredfile_idinteger · int64RequiredResponses200Success!application/jsonResponseany | nullableDefault: null400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/file/{file_id}HTTP
DELETE /api:meta/workspace/{workspace_id}/file/{file_id} HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
No content

​
bulk delete files within workspace

deletehttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file/bulk_deletebulk delete files within workspace Authentication: required Required API Scope: Workspace File: DeleteAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonidsinteger · int64[]RequiredResponses200Success!application/jsonResponseany | nullableDefault: null400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errordelete/workspace/{workspace_id}/file/bulk_deleteHTTP
DELETE /api:meta/workspace/{workspace_id}/file/bulk_delete HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "ids": [
    1
  ]
}
application/jsonTest it200Success!
No content

​
get workspace realtime details

gethttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/realtimeget workspace realtime details Authentication: required Required API Scope: Instance Workspace: ReadAuthorizationsPath parametersworkspace_idinteger · int64RequiredResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorget/workspace/{workspace_id}/realtimeHTTP
GET /api:meta/workspace/{workspace_id}/realtime HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Accept: */*
Test it200Success!
{
  "enabled": true,
  "hash": "Dl3HlakmBZDhezv6yml7hliTM20",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "text",
      "enabled": true,
      "id": 1,
      "pattern": "text",
      "presence": true,
      "wildcard": true
    }
  ]
}

​
update workspace realtime settings

puthttps://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/realtimeupdate workspace realtime settings Authentication: required Required API Scope: Instance Workspace: UpdateAuthorizationsPath parametersworkspace_idinteger · int64RequiredBodyapplication/jsonenabledbooleanOptionalhashstringOptionalchannelsobject[]OptionalShow propertiesResponses200Success!application/jsonResponseobjectShow properties400Input Error. Check the request payload for issues.401Unauthorized403Access denied. Additional privileges are needed access the requested resource.404Not Found. The requested resource does not exist.429Rate Limited. Too many requests.500Unexpected errorput/workspace/{workspace_id}/realtimeHTTP
PUT /api:meta/workspace/{workspace_id}/realtime HTTP/1.1
Host: xxsw-1d5c-nopq.n7d.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "enabled": true,
  "hash": "text",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "text",
      "enabled": true,
      "history": 0,
      "id": 1,
      "pattern": "text",
      "presence": true,
      "wildcard": true
    }
  ]
}
application/jsonTest it200Success!
{
  "enabled": true,
  "hash": "Dl3HlakmBZDhezv6yml7hliTM20",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "text",
      "enabled": true,
      "id": 1,
      "pattern": "text",
      "presence": true,
      "wildcard": true
    }
  ]
}
The Metadata API is flexible regarding sending input values. You only need to send the values required to process your request. For example, if you are updating a schema and want to just update the name, then you only need to send the updated name and the other metadata of the schema will remain unchanged.
For partners wanting an easier way to integrate, it may be useful to start out with the Account API. This way the only prompt from the user will be to get their access token, and then you can use the Account API to get a list of the user’s instances, leading to the Instance API for workspaces, tables, and APIs.
⌘I