Skip to main content
GET
/
accounts
/
self
/
member-details
/
{member_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 getMemberDetails() {
    const reqParams = {
        "memberUserId": '473e1eb612451s'
    }
    const req = await AccountsApiFp(config).getMemberDetails(reqParams);
    const resp = await req(axios);
}

getMemberDetails()
from faxplus import ApiClient, AccountsApi
from faxplus.configuration import Configuration

conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = AccountsApi(api_client)
resp = api.get_member_details(
    member_user_id='473e1eb612451s')
/**
 * Example below uses Apache HTTP Client 4 with Fluent API
 **/

Map<String, String> pathParams = new HashMap<>();
pathParams.put("member_user_id", "'473e1eb612451s'");

StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
String url = sub.replace("https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}");

String result = Request
    .Get(url)
     // The x-fax-clientid header is required only when using the OAuth2 token scheme
    .addHeader("x-fax-clientid", "YOUR_CLIENT_ID")
    .addHeader("Accept", "'application/json'")
    .addHeader("Authorization", "'Bearer {access-token}'")
    .execute()
    .returnContent().asString();

System.out.println(result.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        // The x-fax-clientid header is required only when using the OAuth2 token scheme
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        "x-fax-clientid": []string{"YOUR_CLIENT_ID"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    // The x-fax-clientid header is required only when using the OAuth2 token scheme
    'x-fax-clientid' => '{client ID}',
);

$client = new GuzzleHttp\Client();

try {
    $response = $client->request('GET','https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}', array(
        'headers' => $headers,
        )
    );
    print_r($response->getBody()->getContents());
 }
 catch (GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
# You can also use wget
curl -X GET https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id} \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  # The x-fax-clientid header is required only when using the OAuth2 token scheme
  -H 'x-fax-clientid: "YOUR_CLIENT_ID"'
{
  "quota": 400,
  "role": "Sales Manager"
}
{
"error": "invalid_user_id",
"description": "Invalid user id given"
}
{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}
{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}
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 getMemberDetails() {
    const reqParams = {
        "memberUserId": '473e1eb612451s'
    }
    const req = await AccountsApiFp(config).getMemberDetails(reqParams);
    const resp = await req(axios);
}

getMemberDetails()
from faxplus import ApiClient, AccountsApi
from faxplus.configuration import Configuration

conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = AccountsApi(api_client)
resp = api.get_member_details(
    member_user_id='473e1eb612451s')
/**
 * Example below uses Apache HTTP Client 4 with Fluent API
 **/

Map<String, String> pathParams = new HashMap<>();
pathParams.put("member_user_id", "'473e1eb612451s'");

StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
String url = sub.replace("https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}");

String result = Request
    .Get(url)
     // The x-fax-clientid header is required only when using the OAuth2 token scheme
    .addHeader("x-fax-clientid", "YOUR_CLIENT_ID")
    .addHeader("Accept", "'application/json'")
    .addHeader("Authorization", "'Bearer {access-token}'")
    .execute()
    .returnContent().asString();

System.out.println(result.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        // The x-fax-clientid header is required only when using the OAuth2 token scheme
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        "x-fax-clientid": []string{"YOUR_CLIENT_ID"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    // The x-fax-clientid header is required only when using the OAuth2 token scheme
    'x-fax-clientid' => '{client ID}',
);

$client = new GuzzleHttp\Client();

try {
    $response = $client->request('GET','https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id}', array(
        'headers' => $headers,
        )
    );
    print_r($response->getBody()->getContents());
 }
 catch (GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
# You can also use wget
curl -X GET https://restapi.fax.plus/v3/accounts/self/member-details/{member_user_id} \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  # The x-fax-clientid header is required only when using the OAuth2 token scheme
  -H 'x-fax-clientid: "YOUR_CLIENT_ID"'

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

member_user_id
string
required

Member user ID

Response

Object containing details of member (quota and role)

Company member details

quota
integer

Quota of member (number of pages member can send per month)

Required range: x >= 0
role
string

Role of member in your company