Developer docs: Account

Account

Who the key belongs to, plan, usage and limits.

The calling key, its organization and planLink to The calling key, its organization and plan

GET/me

A connection test: any valid key with at least one scope may call it.

Scope: Any scope

curl "https://bookifycall.com/api/v1/external/me" \
  -H "X-API-Key: $BOOKIFYCALL_API_KEY"

Example response · 200

{
  "success": true,
  "data": {
    "organization": {
      "id": "00000000-0000-4000-8000-000000000100",
      "name": "Example Dental"
    },
    "plan": {
      "slug": "enterprise",
      "status": "active",
      "apiAccess": true,
      "webhookSupport": true
    },
    "apiKey": {
      "id": "00000000-0000-4000-8000-000000000009",
      "name": "CRM integration",
      "keyPrefix": "bck_1a2b3c4d",
      "scopes": [
        "calls:read",
        "leads:read",
        "appointments:read"
      ],
      "agentId": null,
      "expiresAt": null,
      "lastUsedAt": "2026-10-16T12:00:00.000Z",
      "createdAt": "2026-10-01T09:00:00.000Z"
    },
    "rateLimit": {
      "requestsPerMinute": 60
    }
  }
}

Minutes used this billing period and plan limitsLink to Minutes used this billing period and plan limits

GET/usage

Organization-wide. `limit: -1` means unlimited. Minutes are AI minutes, rounded up per call.

Scope: calls:read

curl "https://bookifycall.com/api/v1/external/usage" \
  -H "X-API-Key: $BOOKIFYCALL_API_KEY"

Example response · 200

{
  "success": true,
  "data": {
    "plan": "enterprise",
    "period": {
      "start": "2026-10-01T00:00:00.000Z",
      "end": "2026-11-01T00:00:00.000Z"
    },
    "minutes": {
      "used": 1260,
      "limit": 5000,
      "percentUsed": 25,
      "overage": 0
    },
    "calls": 412,
    "agents": {
      "used": 3,
      "limit": 10
    },
    "phoneNumbers": {
      "used": 3,
      "limit": 10
    },
    "concurrentCalls": {
      "limit": 10
    },
    "trialEnded": false
  }
}

Next: Analytics