Accounts API reference

Connection status, granted accounts and limits.

Requests go to https://api.revdoku.com. Every path starts with /v1, for example https://api.revdoku.com/v1/buckets. Send Authorization: Bearer $REVDOKU_API_KEY from your server. Tables use JSON names; where TypeScript differs, a field shows json_name / typescriptName. Python uses the JSON names.

All operations · API guide · Errors · OpenAPI

• Read the connection and selected account: GET /v1/status
• List accounts granted to this credential: GET /v1/accounts
• Create a client account: POST /v1/accounts
• Read one granted account: GET /v1/accounts/{account_id}
• Read effective account limits: GET /v1/account/limits

Read the connection and selected account

GET /v1/status

Works with every API key, including bucket-scoped keys. Read quotas with GET /v1/account/limits.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getStatus();
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_status()
print(response.data)

cURL

curl "https://api.revdoku.com/v1/status" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "connected": true,
    "default_account_id": "acct_example",
    "accounts": [
      {
        "id": "acct_example",
        "name": "Acme",
        "account_kind": "standard",
        "client_name": null,
        "agency_account": null
      }
    ],
    "server_version": "1.0.575",
    "client_version": "1.0.575",
    "features": {"email_domains": true},
    "account": {
      "id": "acct_example",
      "name": "Acme",
      "status": "active",
      "account_kind": "standard",
      "client_name": null,
      "agency_account": null,
      "can_create_client_account": false,
      "can_manage_billing": true,
      "billing_message": null,
      "previous_status": null,
      "status_reason": null,
      "status_updated_at": null
    },
    "user": {
      "id": "user_example",
      "email": "ada@example.com",
      "name": "Ada Lovelace"
    },
    "dashboard_url": "https://app.revdoku.com/buckets?account_id=acct_example",
    "connection": {
      "api_key_id": "atok_example",
      "label": "Orders backend",
      "token_type": "api",
      "scope": "bucket_admin",
      "expires_at": "2027-10-11T12:00:00Z",
      "last_used_at": "2026-10-11T12:20:00Z",
      "bucket_access": "all",
      "bucket_ids": [],
      "denied_bucket_ids": [],
      "bucket_permissions": {},
      "permissions": {"read": true, "write": true, "admin": true},
      "agent": null,
      "transport": "api_key",
      "renewal": {"recommended": false}
    }
  }
}

Errors

Guide: Accounts

List accounts granted to this credential

GET /v1/accounts

Works with every API key. Lists the account of this credential and the client accounts that an agency owner granted to it. Send an id from this list as account_id to act in that account.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.listAccounts();
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.list_accounts()
print(response.data)

cURL

curl "https://api.revdoku.com/v1/accounts" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "default_account_id": "acct_example",
    "accounts": [
      {
        "id": "acct_example",
        "name": "Acme",
        "account_kind": "standard",
        "client_name": null,
        "agency_account": null,
        "region": "eu",
        "status": "active",
        "permissions": {
          "scope": "bucket_admin",
          "bucket_access": "all",
          "can_create_buckets": true
        }
      }
    ],
    "pagination": {"limit": 50, "has_more": false, "next_cursor": null}
  }
}

Errors

Guide: Accounts

Create a client account

POST /v1/accounts

Requires an agency owner credential with client-account access.

The credential default does not change; send the new account_id on later requests.

Request body: TypeScript createClientAccountRequest: CreateClientAccountRequest, Python create_client_account_request=CreateClientAccountRequest(...).

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.createClientAccount({
  createClientAccountRequest: { name: 'Example client' },
});
console.log(data);

Python

from revdoku import Revdoku, CreateClientAccountRequest

client = Revdoku()
response = client.api.create_client_account(
    CreateClientAccountRequest(name="Example client"),
)
print(response.data)

cURL

curl -X POST "https://api.revdoku.com/v1/accounts" \
  -H "Authorization: Bearer $REVDOKU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Example client"}'

Response 201

Errors

Guide: Client accounts

Read one granted account

GET /v1/accounts/{account_id}

Works with every API key. Returns the name, kind, region and status of one account that this credential can use, and the permissions of the credential in it. Other account IDs return 403.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getAccount({ accountId: 'acct_example' });
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_account("acct_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/accounts/acct_example" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "account": {
      "id": "acct_example",
      "name": "Acme",
      "account_kind": "standard",
      "client_name": null,
      "agency_account": null,
      "region": "eu",
      "status": "active",
      "permissions": {
        "scope": "bucket_admin",
        "bucket_access": "all",
        "can_create_buckets": true
      }
    }
  }
}

Errors

Guide: Accounts

Read effective account limits

GET /v1/account/limits

Values come from the plan and account overrides. Zero means no allowance; null means no cap. Storage, bucket and email traffic allowances are shared within a billing group.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getAccountLimits();
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_account_limits()
print(response.data)

cURL

curl "https://api.revdoku.com/v1/account/limits" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

{
  "success": true,
  "data": {
    "account_id": "acct_example",
    "limits": {
      "max_buckets": 3,
      "max_bucket_creations_per_month": 12,
      "max_files_per_bucket": 25000,
      "max_current_files": 40000,
      "max_storage_bytes": 2147483648,
      "max_file_size_bytes": 52428800,
      "max_pdf_size_bytes": 52428800,
      "max_file_versions_per_file": 15,
      "max_email_aliases_per_bucket": 4,
      "max_email_domains": 3,
      "max_received_emails_per_month": 1500,
      "max_received_email_bytes_per_month": 268435456,
      "max_received_email_message_bytes": 20971520,
      "max_sent_emails_per_month": 750,
      "max_email_address_rotations_per_month": 6,
      "max_account_members": 3,
      "max_api_keys": 4,
      "max_agent_connections": 7,
      "api_rate_limit_requests_per_minute": 240,
      "audit_retention_days": 45
    },
    "usage": {
      "bucket_creations": {
        "monthly_limit": 12,
        "used": 2,
        "remaining": 10,
        "resets_at": "2026-11-01T00:00:00Z"
      }
    }
  }
}

Errors

Guide: Limits