ErzyCall API
    ErzyCall API

    Getting Started

    Quick StartAuthentication

    Guides

    Rate LimitingError HandlingWebhooks

    MCP

    OverviewChat assistantsCoding toolsAutomation platformsTools & permissionsTroubleshooting

    API Reference

    CallsContactsCasesAssistantsPhone NumbersContact GroupsUsageWebhook EndpointsWhatsApp

    Contact Groups

    List contact groups for your organization.

    Contact groups let you organize contacts into categories. The API provides read-only access to groups — manage them through the ErzyCall dashboard.

    List Contact Groups

    GET /api/v1/contact-groups

    Required scope: contact_groups:read

    Example Request

    curl -X GET "https://app.erzycall.com/api/v1/contact-groups" \
      -H "X-API-Key: ek_live_abc123"

    Example Response

    {
      "data": [
        {
          "id": "grp_001",
          "name": "Enterprise Clients",
          "contactCount": 42,
          "createdAt": "2025-01-02T10:00:00Z"
        },
        {
          "id": "grp_002",
          "name": "Trial Users",
          "contactCount": 15,
          "createdAt": "2025-01-05T14:30:00Z"
        }
      ]
    }

    Usage

    Use group IDs from this list to:

    • Filter contacts by group — pass groupId when listing contacts.
    • Assign contacts to groups — include groupIds when creating or updating a contact.

    Phone Numbers

    List phone numbers assigned to your organization.

    Usage

    Read your organization's plan, minute balance, spend, and usage history.

    On this page

    List Contact GroupsExample RequestExample ResponseUsage