ErzyCall API
    ErzyCall API

    Getting Started

    Quick StartAuthentication

    Guides

    Rate LimitingError HandlingWebhooks

    API Reference

    CallsContactsCasesAssistantsPhone NumbersContact GroupsWebhook EndpointsWhatsApp

    Quick Start

    Get up and running with the ErzyCall REST API in minutes.

    The ErzyCall REST API lets you programmatically manage calls, contacts, cases, assistants, and more. All endpoints are available at:

    https://app.erzycall.com/api/v1/

    1. Create an API Key

    Go to Settings > API Keys in the ErzyCall dashboard and click Create API Key. Choose the scopes your integration needs, then copy the key — it's only shown once.

    2. Make Your First Request

    curl -X GET "https://app.erzycall.com/api/v1/calls?limit=5" \
      -H "X-API-Key: ek_live_your_api_key_here"

    3. Inspect the Response

    All successful responses return data in a consistent envelope:

    {
      "data": [
        {
          "id": "abc123",
          "status": "ended",
          "to": "+14155551234",
          "from": "+14155559999",
          "createdAt": "2025-01-15T10:30:00Z"
        }
      ],
      "pagination": {
        "cursor": "eyJwb3...",
        "hasMore": true,
        "pageSize": 5
      }
    }

    Base URL

    EnvironmentBase URL
    Productionhttps://app.erzycall.com/api/v1

    Key Concepts

    • Authentication — Every request requires an X-API-Key header. See Authentication.
    • Scopes — API keys can be scoped to specific resources and actions (e.g. calls:read, contacts:write).
    • Pagination — List endpoints use cursor-based pagination. See individual endpoint docs for details.
    • Rate Limits — 60 requests/minute and 1,000 requests/hour per API key. See Rate Limiting.
    • Webhooks — Get notified when events happen. See Webhooks.

    Available Resources

    ResourceEndpointsDescription
    CallsGET POST DELETEManage outbound voice calls
    ContactsGET POST PATCH DELETECRUD operations on contacts
    CasesGETView case records
    AssistantsGET PATCHManage inbound and outbound assistants
    Phone NumbersGETList assigned phone numbers
    Contact GroupsGETList contact groups
    Webhook EndpointsGET POST PATCH DELETEManage webhook subscriptions

    Authentication

    How to authenticate with the ErzyCall REST API using API keys.

    On this page

    1. Create an API Key2. Make Your First Request3. Inspect the ResponseBase URLKey ConceptsAvailable Resources