API referenceContacts

List contact groups

gethttps://api.expiryedge.com/v1/getAllContactGroups
any role (admin, editor or viewer)60/min
Request
curl 'https://api.expiryedge.com/v1/getAllContactGroups' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "groups": [
    {
      "id": "grp_5Nc1",
      "organization_id": "org_northwind",
      "name": "Licensing",
      "color": "#1976d2",
      "sortOrder": 0,
      "count": 4,
      "createdAt": "2026-09-27T14:05:00.000Z",
      "updatedAt": "2026-09-27T14:05:00.000Z"
    }
  ],
  "totalContacts": 9,
  "ungroupedCount": 5
}

Returns every group in the organization with its member count, sorted by sortOrder then name, plus totalContacts and ungroupedCount. On the first call for an organization, groups are created from the group names already on contacts. Unbounded.

Returns

200
Groups with counts.
  • groupsarray of objectsrequired
  • totalContactsintegerrequired
  • ungroupedCountintegerrequired

Errors

401
Missing, expired or invalid bearer token.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.