Profile

Retrieve a profile

Returns the profile and billing details of the authenticated account.

get/v1/profile

Response

Returns the profile.

idinteger required

Account ID.

emailstring required

Email associated with the account.

first_namestring nullable required

Account owner's first name.

last_namestring nullable required

Account owner's last name.

phonestring nullable required

Account owner's phone number.

additional_infostring nullable required

Additional info associated with the account.

contact_emailstring nullable required

Additional email address for billing notifications.

timezonestring required

Timezone configured on the account.

job_titlestring nullable required

Account owner's job title.

default_short_link_endpointstring nullable required

Default short link endpoint.

Example response

{
  "id": 1,
  "email": "info@awesome.com",
  "first_name": "Jason",
  "last_name": "Androux",
  "phone": "13291019312",
  "additional_info": "Additional info",
  "contact_email": "billing@awesome.com",
  "timezone": "Pacific/Wallis",
  "job_title": "Manager",
  "default_short_link_endpoint": "https://short.examples.com",
  "default_destinations": [
    {
      "transport": "sms",
      "value": "https://webhook.address.com/inboundSMS"
    }
  ],
  "company_info": {
    "name": "Awesome company",
    "industry": "telecommunications",
    "address": "Baker street",
    "attn_contact_name": "James Scott",
    "vat_number": "VAT123456789",
    "country": {
      "country_name": "United States",
      "country_id": 1
    }
  }
}

Changes

Changed in 3 of the 50 revisions of this API.1514

May 25, 202633be779051201511See the full diff
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ●
  added the new undefined enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 20, 20262e48fd9894e12See the full diff
- ○
  api operation id Getcustomerinfo removed and replaced with profile_get
  api-operation-id-removed
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 163 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 12, 2026fabaadf195a91See the full diff
- ○
  endpoint added
  endpoint-added

Full history