SEsentdm
Accounts

Get authenticated account

Changed on

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.

Sending number: sending_phone_number is the account's US SMS sender. It is intentionally the same value as channels.sms.phone_number — the two are kept in step, and it is published under both names because sending_phone_number is what this value is called on GET /v3/profiles. Read either. One difference: sending_phone_number is always present, including as null, while channels.sms.phone_number is omitted when there is no sender.

sending_phone_number_profile_id names the account that holds that number in inventory — normally this account, and a different one where a number is shared. Both are null when the account has no US SMS sender.

Template auto-creation: enable_template_auto_creation_for_sp reports whether this account may mark a template for automatic creation on its sender profiles. It is granted by Sent and off by default. A profile reports false, having no sender profiles of its own to create anything on.

get/v3/me

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/me
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

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

Changes

  • 6c829543a93eRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status