Get API capabilities

GET

/v1/capabilities

const url = 'https://api.submeto.com/v1/capabilities';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.submeto.com/v1/capabilities \
  --header 'Authorization: Bearer <token>'

Returns the API version, the scopes granted to this API key, form access mode, key expiry state, write availability, and the effective rate limits for the key's plan.

Authorizations

default

Responses

200

Capabilities

application/json

object

data

object

api_version

string

scopes

Array<string>

form_access_mode

string

expires_at

string

expiring_soon

boolean

writes_enabled

boolean

rate_limits

object

read_per_minute

integer

write_per_minute

integer

destructive_per_minute

integer

user_aggregate_per_minute

integer

request_id

string

Example

{
  "data": {
    "api_version": "1",
    "scopes": [
      "forms:read",
      "forms:create"
    ],
    "form_access_mode": "all",
    "expires_at": "2027-01-01T00:00:00.000Z",
    "expiring_soon": false,
    "writes_enabled": true,
    "rate_limits": {
      "read_per_minute": 300,
      "write_per_minute": 100,
      "destructive_per_minute": 30,
      "user_aggregate_per_minute": 1000
    }
  },
  "request_id": "REQUEST_ID"
}

401

Invalid API key

application/json

object

error

object

code

string

message

string

details

object

request_id

string

Example

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key.",
    "details": {}
  },
  "request_id": "REQUEST_ID"
}