API reference

Tokens

3 operations, generated from the OpenAPI document.

The caller's personal access tokens (never their secrets)

GET /api/me/tokens

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • tokens array of object required
      • id string (uuid) required
      • name string required
      • prefix string required
      • scopes array of "data.records:read" | "data.records:write" | "data.recordComments:read" | "data.recordComments:write" | "schema.bases:read" | "schema.bases:write" | "webhook:manage" | "automations:read" | … required
      • workspaceIds array of string (uuid) required
      • baseIds array of string (uuid) required
      • createdAt string (date-time) required
      • expiresAt string (date-time) required
      • lastUsedAt string (date-time) | null required
      • usage array of object required
        • day string (date) required
        • requests integer required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Create a personal access token; the answer is the only time its secret is shown

POST /api/me/tokens

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Request body

  • name string required
  • scopes array of "data.records:read" | "data.records:write" | "data.recordComments:read" | "data.recordComments:write" | "schema.bases:read" | "schema.bases:write" | "webhook:manage" | "automations:read" | … required
  • workspaceIds array of string (uuid)
  • baseIds array of string (uuid)
  • expiresInDays integer

Responses

  • 201 Success
    • id string (uuid) required
    • name string required
    • prefix string required
    • scopes array of "data.records:read" | "data.records:write" | "data.recordComments:read" | "data.recordComments:write" | "schema.bases:read" | "schema.bases:write" | "webhook:manage" | "automations:read" | … required
    • workspaceIds array of string (uuid) required
    • baseIds array of string (uuid) required
    • createdAt string (date-time) required
    • expiresAt string (date-time) required
    • lastUsedAt string (date-time) | null required
    • usage array of object required
      • day string (date) required
      • requests integer required
    • token string required
  • 401 Not signed in
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Revoke a personal access token

DELETE /api/me/tokens/{tokenId}

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

NameInTypeRequired
tokenIdpathstring (uuid)yes

Responses

  • 204 Success, no content
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)