ErzyCall API
    ErzyCall API

    Getting Started

    Quick StartAuthentication

    Guides

    Rate LimitingError HandlingWebhooks

    API Reference

    CallsContactsCasesAssistantsPhone NumbersContact GroupsWebhook EndpointsWhatsApp

    Cases

    List and view case records — reusable call scripts with AI instructions.

    A case is a reusable call script that defines everything the AI assistant needs for a conversation:

    • First Message — the opening line (supports {{variables}})
    • System Prompt — personality, instructions, and conversation flow
    • Tools — actions the AI can take (e.g., book a meeting, end the call)
    • Variables — dynamic placeholders resolved from contact data or custom values

    Pass a caseId when creating a call to use the case as the call script. The API provides read-only access to cases — create and edit them in the dashboard.

    List Cases

    Retrieve a paginated list of cases.

    GET /api/v1/cases

    Required scope: cases:read

    Query Parameters

    ParameterTypeDefaultDescription
    limitinteger25Results per page (1–100)
    cursorstring—Pagination cursor from a previous response

    Example Request

    curl -X GET "https://app.erzycall.com/api/v1/cases?limit=10" \
      -H "X-API-Key: ek_live_abc123"

    Example Response

    {
      "data": [
        {
          "id": "case_789",
          "title": "Customer onboarding - Acme Inc",
          "status": "open",
          "createdAt": "2025-01-12T09:00:00Z"
        }
      ],
      "pagination": {
        "cursor": "eyJwb3...",
        "hasMore": false,
        "pageSize": 10
      }
    }

    Get Case

    Retrieve details for a single case.

    GET /api/v1/cases/{id}

    Required scope: cases:read

    Example Request

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

    Example Response

    {
      "data": {
        "id": "case_789",
        "title": "Customer onboarding - Acme Inc",
        "status": "open",
        "createdAt": "2025-01-12T09:00:00Z"
      }
    }

    Contacts

    Create, read, update, delete, and search contacts.

    Assistants

    List and manage inbound and outbound AI voice assistants.

    On this page

    List CasesQuery ParametersExample RequestExample ResponseGet CaseExample RequestExample Response