GET
/
accounts
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 getAccounts() {
    const req = await AccountsApiFp(config).getAccounts();
    const resp = await req(axios);
}

getAccounts()

{
  "members": [
    {
      "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
        }
      },
      "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 getAccounts() {
    const req = await AccountsApiFp(config).getAccounts();
    const resp = await req(axios);
}

getAccounts()

Authorizations

​
Authorization
string
header
required

Personal Access Token (PAT) Bearer token used for secure API calls

Response

200
application/json

Object containing account information

List of user accounts