Sign in

v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Accounts

Get account information

Get information about an account. For members user_id can only be self. For admin it can be either self, or a user_id of any corporate member. (Permitted scopes: fax:all:read, fax:member:read, fax:user:read)

get/accounts/{user_id}

Path parameters

user_idstring required

User ID to get information about. For your own account use 'self'

Response

Object containing account information

account_type'corporate_admin' | 'individual' | 'corporate_member' required

Account type which could be corporate_admin, individual, etc

creation_datestring required

Creation date in UTC. Format: YYYY-MM-DD HH:mm:ss

emailstring required

Account email address

last_password_modification_datestring

The date on which you have changed your password

lastnamestring

Your last name

member_ofstring[]

List of user ids that you are member of.

namestring

Your first name

phonestring

Your account phone number

profile_imagestring

Profile image path

status'active' | 'unverified_phone' | 'suspended' | 'disabled' | 'inactive' | 'deleted' | 'corporate_deleted' | 'waiting_for_signup' required

Your account status which could be active, inactive etc

uidstring required

User ID of current user

Example response

{
  "account_data": {
    "company_name": "Company name",
    "default_file_type": "pdf",
    "save_history": true
  },
  "account_type": "corporate_admin",
  "creation_date": "2017-05-06 05:22:21",
  "email": "sample@fax.plus",
  "last_password_modification_date": "2017-05-06 05:22:21",
  "lastname": "Smith",
  "member_of": {},
  "notifications": {
    "black_list": {
      "uids": []
    },
    "settings": {
      "email": {
        "addresses": [
          "sample@fax.plus"
        ],
        "low_credit": true,
        "new_feature": true,
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      },
      "language": "fa",
      "push_notifications": {
        "low_credit": true,
        "new_feature": true,
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      },
      "sms": {
        "low_credit": true,
        "new_feature": true,
        "numbers": [
          "+16699990000"
        ],
        "receive_fax": true,
        "send_fax": true,
        "voicemail": true
      }
    }
  },
  "phone": "+16699990000",
  "profile_image": "",
  "settings": {
    "caller_id_name": "Fax.Plus",
    "send_fax": {
      "options": {},
      "retry": {
        "count": 0,
        "delay": 0
      },
      "should_enhance": true,
      "default_resolution": "fine",
      "partially_sent_retry": false
    }
  },
  "status": "active",
  "uid": "7724157c0974440293e45877c57f0703"
}
All 61 operations