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

Header Parameters

x-profile-id?string

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.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://api.sent.dm/v3/me"
{
  "success": true,
  "data": {
    "type": "profile",
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Marketing",
    "short_name": "MKT",
    "email": "marketing@acme.com",
    "icon": "https://cdn.sent.dm/icons/marketing.png",
    "description": "Marketing department sender profile",
    "created_at": "2025-01-20T14:00:00+00:00",
    "channels": {
      "sms": {
        "configured": true,
        "phone_number": "+14155550100"
      },
      "whatsapp": {
        "configured": true,
        "phone_number": "+14155550100",
        "business_name": "Acme Corporation"
      },
      "rcs": {
        "configured": false,
        "phone_number": "+14155550100"
      }
    },
    "status": "approved",
    "settings": {
      "allow_contact_sharing": true,
      "allow_template_sharing": true,
      "inherit_contacts": true,
      "inherit_templates": false,
      "inherit_tcr_brand": true,
      "inherit_tcr_campaign": false,
      "billing_model": "organization"
    },
    "profiles": []
  },
  "error": null,
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2705837+00:00",
    "version": "v3"
  }
}
{
  "success": false,
  "data": null,
  "error": {
    "code": "AUTH_001",
    "message": "Invalid or missing API key. Ensure the x-api-key header is set with a valid key.",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/AUTH_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2705884+00:00",
    "version": "v3"
  }
}
Empty
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_001",
    "message": "An unexpected error occurred while retrieving account information. Please try again later.",
    "details": null,
    "doc_url": "https://docs.sent.dm/errors/INTERNAL_001"
  },
  "meta": {
    "request_id": "req_7X9zKp2jDw",
    "timestamp": "2026-03-11T21:50:50.2705892+00:00",
    "version": "v3"
  }
}

Get available webhook event types GET

Retrieves all available webhook event types that can be subscribed to.

Get phone number details GET

Retrieves detailed information about a phone number including carrier, line type, porting status, and VoIP detection. Uses the customer's messaging provider for rich data, with fallback to the internal index.