Account

Who am I: the API client, the account and the granted scopes

GET /v1/me

Scope: No scope needed (any active key)
Tier: Tier 1
Data: Account data
Idempotency: Idempotency-Key: not used

Answers from the authentication step only; it calls no platform service. Every active key can call it, even one with no scopes, so use it to check a new key. It never returns an internal account id.

Parameters

Name	In	Type	Required	Description
`X-Correlation-ID`	header	string	no	Your own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128)

Response

200: The calling API client.

Header	Meaning
`X-Request-ID`	The DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API.
`Cache-Control`	Always `no-store`.

Examples

Request example

curl

curl -sS -X GET \
  "https://app.dialerbee.com/api/v1/me" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY"

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.me.get()

Response example

200

{
  "client": {
    "id": "cli_0f8fad5b-d9cb-469f-a165-70867728950e",
    "name": "CRM sync (production)",
    "environment": "live"
  },
  "account": {
    "name": "Example Clinic"
  },
  "scopes": [
    "leads:read",
    "leads:write",
    "calls:read",
    "recordings:read",
    "webhooks:read"
  ],
  "tier2": {
    "campaign_resume": false,
    "callback_write": false,
    "appointment_write": false,
    "consent_write": false,
    "sms_send": false,
    "calls_originate": false
  }
}

Error examples

401 invalid_api_key

{
  "type": "https://docs.dialerbee.com/errors/invalid-api-key",
  "title": "Invalid API key",
  "status": 401,
  "detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "invalid_api_key",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

Errors

Status	Code	Title
401	`invalid_api_key`	Invalid API key
403	`api_access_disabled`	API access disabled
403	`ip_not_allowed`	IP address not allowed
400	`credential_in_url`	Credential in URL
400, 422	`validation_failed`	Invalid request
429	`rate_limit_exceeded`	Too many requests
503	`temporarily_unavailable`	Temporarily unavailable
503	`upstream_unavailable`	Temporarily unavailable
502	`upstream_invalid_response`	Upstream error
500	`internal_error`	Internal error

Objects

Me

Field	Type	Required	Description
`client`	MeClient	yes
`account`	MeAccount	yes
`scopes`	array of one of `leads:read`, `leads:write`, `campaigns:read`, `campaigns:pause`, `campaigns:resume`, `calls:read`, `recordings:read`, `transcripts:read`, `summaries:read`, `webhooks:read`, `webhooks:write`, `dnc:check`, `dnc:add`, `consent:write`, `callbacks:read`, `callbacks:cancel`, `callbacks:write`, `appointments:read`, `appointments:write`, `sms:read`, `messages:send`, `reports:read`, `calls:originate`, `whatsapp:send`	yes
`tier2`	Tier2Status	yes	Which Tier-2 capabilities are switched on for the account. The client still needs the matching scope.

MeClient

Field	Type	Required	Description
`id`	string (ApiClientId)	yes	An API client (an integration). Its credentials (keys) belong to it. `cli_` + a lower-case UUID.
`name`	string	yes
`environment`	one of `live`, `test`	yes

MeAccount

Field	Type	Required	Description
`name`	string	yes

Tier2Status

Which Tier-2 capabilities are switched on for the account. The client still needs the matching scope.

Field	Type	Required
`campaign_resume`	boolean	yes
`callback_write`	boolean	yes
`appointment_write`	boolean	yes
`consent_write`	boolean	yes
`sms_send`	boolean	yes
`calls_originate`	boolean	yes