Skip to main content
GET
/
accounts
/
{user_id}
const axios = require('axios');
const AccountsApiFp = require('@alohi/faxplus-api').AccountsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getUser() {
    const reqParams = {
        "userId": '473e1eb6'
    }
    const req = await AccountsApiFp(config).getUser(reqParams);
    const resp = await req(axios);
}

getUser()

{
  "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": "[email protected]",
  "last_password_modification_date": "2017-05-06 05:22:21",
  "lastname": "Smith",
  "member_of": {},
  "notifications": {
    "black_list": {
      "uids": []
    },
    "settings": {
      "email": {
        "addresses": [
          "[email protected]"
        ],
        "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"
}
const axios = require('axios');
const AccountsApiFp = require('@alohi/faxplus-api').AccountsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function getUser() {
    const reqParams = {
        "userId": '473e1eb6'
    }
    const req = await AccountsApiFp(config).getUser(reqParams);
    const resp = await req(axios);
}

getUser()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

​
user_id
string
default:self
required

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

Response

Object containing account information

User account model

​
account_type
enum<string>
required

Account type which could be corporate_admin, individual, etc

Available options:
corporate_admin,
individual,
corporate_member
​
creation_date
string
required

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

​
email
string
required

Account email address

​
status
enum<string>
required

Your account status which could be active, inactive etc

Available options:
active,
unverified_phone,
suspended,
disabled,
inactive,
deleted,
corporate_deleted,
waiting_for_signup
​
uid
string
required

User ID of current user

​
account_data
object
​
last_password_modification_date
string

The date on which you have changed your password

​
lastname
string

Your last name

​
member_of
string[]

List of user ids that you are member of.

​
name
string

Your first name

​
notifications
object

Account notification settings

​
phone
string

Your account phone number

​
profile_image
string

Profile image path

​
settings
object

Account settings