FAfax
Contacts

List contact groups

Get contact groups with optional search and pagination. You can also retrieve specific groups by providing comma-separated IDs (Permitted scopes: fax:all:read)

get/accounts/self/contact-groups

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/self/contact-groups
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all

Query parameters

idsstring

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

groupstring

Search term to filter groups

offsetinteger

Offset for pagination

limitinteger

Limit for pagination (max 50)

sharedboolean

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

Response

Response containing a list of groups

total_countinteger

Total number of groups matching the query

Example response

{
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.