v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB
Accounts

Get authenticated account

Returns the account associated with the provided API key. The response includes account identity, contact information, messaging channel configuration, and — depending on the account type — either a list of child profiles or the profile's own settings.

Account types:

  • organization — Has child profiles. The profiles array is populated.
  • user — Standalone account with no profiles.
  • profile — Child of an organization. Includes organization_id, short_name, status, and settings.

Channels: The channels object always includes sms, whatsapp, and rcs. Each channel has a configured boolean. Configured channels expose additional details such as phone_number.

get/v3/me

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Account retrieved successfully. Response shape varies by account type (organization, user, or profile).

successboolean

Indicates whether the request was successful