Skip to main content
GET
/
accounts
/
self
/
contact-groups
const axios = require('axios');
const ContactsApiFp = require('@alohi/faxplus-api').ContactsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function listContactGroups() {
    const req = await ContactsApiFp(config).listContactGroups({
        userId: 'self',
        search: '',
        offset: 0,
        limit: 50
    });
    const resp = await req(axios);
}

listContactGroups()

{
  "records": [
    {
      "id": "5f7a8b9c0d1e2f3a4b5c6d7f",
      "name": "VIP Clients",
      "notes": "Important clients only",
      "is_shared": true,
      "creation_date": "2024-01-10T09:00:00Z",
      "modification_date": "2024-02-15T11:20:00Z"
    }
  ],
  "total_count": 123
}
const axios = require('axios');
const ContactsApiFp = require('@alohi/faxplus-api').ContactsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function listContactGroups() {
    const req = await ContactsApiFp(config).listContactGroups({
        userId: 'self',
        search: '',
        offset: 0,
        limit: 50
    });
    const resp = await req(axios);
}

listContactGroups()

Authorizations

​
Authorization
string
header
required

Personal Access Token (PAT) is a Bearer token used for secure API calls. For direct API calls, the PAT is used in the Authorization header as 'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client settings (e.g., in your IDE's MCP server configuration) - authentication will be handled automatically.

Query Parameters

​
ids
string

Comma-separated list of group IDs to retrieve (max 50). When provided, other filters are ignored

​
group
string

Search term to filter groups

​
offset
integer
default:0

Offset for pagination

​
limit
integer
default:50

Limit for pagination (max 50)

Required range: x <= 50
​
shared
boolean
default:false

If true, return shared/corporate groups. If false, return personal groups

Response

Response containing a list of groups

​
records
object[]

List of groups

​
total_count
integer

Total number of groups matching the query