Get account details

Returns details of the user the API key belongs to. Also a simple way to check that your credentials work without sending a message.

GET

https://app.touchsms.com.au/api/v2/account

Authorization

basicAuth
HTTP
required

Returns

200

Account details.

JSON

data
optional
object
- id
  optional
  integer
- firstname
  optional
  string
- surname
  optional
  string
- full_name
  optional
  string
- email
  optional
  string
  format: email
- mobile
  optional
  string | null
- credits
  optional
  number
  Current credit balance.
- settings
  optional
  object
  timezone
  optional
  string
  allow_contact_duplicates
  optional
  boolean
  allow_sms_duplicates
  optional
  boolean
  email_reply
  optional
  boolean | integer | null
  Whether replies are forwarded by email.
  
  email_to_sms_enabled
  optional
  boolean | integer | null
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

Get account details

curl --request GET \
  --url https://app.touchsms.com.au/api/v2/account \
  --header 'Authorization: Basic <credentials>'

const url = 'https://app.touchsms.com.au/api/v2/account';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": 5678,
    "firstname": "Sam",
    "surname": "Taylor",
    "full_name": "Sam Taylor",
    "email": "sam@example.com",
    "mobile": "61412345678",
    "settings": {
      "timezone": "Australia/Sydney",
      "allow_contact_duplicates": false,
      "allow_sms_duplicates": false,
      "email_reply": true,
      "email_to_sms_enabled": false
    }
  }
}

{
  "message": "Unauthenticated."
}