NeverMiss API Documentation

Authentication

All API requests require an API key passed via the x-api-key header.

Example Request Header

x-api-key: nm_live_your_api_key_here

Your API key is available in your NeverMiss dashboard. Contact [email protected] if you need one.

Calls

Retrieve call records and detailed call information including transcripts.

GET /calls

Returns a list of all calls handled by NeverMiss.

Query Parameters

Parameter	Type	Description
`limit`	integer	Maximum number of calls to return (default: 50)

Response

// 200 OK
{
  "data": [
    {
      "id": "call_01HXK2V...",
      "caller_name": "John Smith",
      "phone_number": "+15551234567",
      "timestamp": "2026-04-11T14:30:00Z",
      "duration_seconds": 184,
      "status": "completed",
      "call_type": "inbound",
      "summary": "Customer called about AC repair..."
    }
  ],
  "count": 20
}

GET /calls/{id}

Returns full details of a specific call, including the complete transcript.

Path Parameters

Parameter	Type	Description
`id` REQUIRED	string	The unique call ID

Response

// 200 OK
{
  "data": {
    "id": "call_01HXK2V...",
    "caller_name": "John Smith",
    "phone_number": "+15551234567",
    "timestamp": "2026-04-11T14:30:00Z",
    "duration_seconds": 184,
    "status": "completed",
    "call_type": "inbound",
    "summary": "Customer called about AC repair...",
    "transcript": [
      { "speaker": "agent", "text": "Thank you for calling..." },
      { "speaker": "caller", "text": "Hi, I need help with..." }
    ]
  }
}

Leads

Access captured leads from inbound calls.

GET /leads

Returns all captured leads.

Response

// 200 OK
{
  "data": [
    {
      "id": "lead_01HXL3A...",
      "name": "Jane Doe",
      "phone_number": "+15559876543",
      "email": "[email protected]",
      "address": "123 Main St, Austin, TX",
      "service_needed": "AC Installation",
      "urgency_level": "high",
      "source": "inbound_call",
      "status": "new",
      "created_at": "2026-04-11T14:35:00Z"
    }
  ],
  "count": 15
}

GET /leads/{id}

Returns full details of a specific lead.

Path Parameters

Parameter	Type	Description
`id` REQUIRED	string	The unique lead ID

Bookings

Access appointment bookings made through the AI receptionist.

GET /bookings

Returns all booked appointments.

Response

// 200 OK
{
  "data": [
    {
      "id": "book_01HXM4A...",
      "customer_name": "Bob Johnson",
      "phone_number": "+15551112222",
      "service_type": "HVAC Maintenance",
      "scheduled_date": "2026-04-15",
      "scheduled_time": "09:00",
      "address": "456 Oak Ave, Houston, TX",
      "notes": "Annual AC tune-up",
      "status": "confirmed",
      "created_at": "2026-04-11T15:00:00Z"
    }
  ],
  "count": 10
}

GET /bookings/{id}

Returns full details of a specific booking.

Path Parameters

Parameter	Type	Description
`id` REQUIRED	string	The unique booking ID

Stats

Aggregate call statistics and performance metrics.

GET /stats

Returns aggregate call statistics including total calls, missed calls, average duration, leads captured, bookings, and busiest hour.

Response

// 200 OK
{
  "data": {
    "total_calls_today": 12,
    "total_calls_this_week": 67,
    "total_calls_this_month": 248,
    "missed_calls_today": 0,
    "average_call_duration_seconds": 184,
    "total_leads_captured": 15,
    "total_bookings": 10,
    "busiest_hour": "14:00 UTC",
    "response_time_average_seconds": 12
  }
}

Webhooks

Register webhook URLs to receive real-time notifications for events.

POST /webhooks

Registers a new webhook endpoint to receive event notifications.

Request Body

Parameter	Type	Description
`url` REQUIRED	string	The URL to send notifications to
`events` REQUIRED	array	Events to subscribe to: `new_call`, `missed_call`, `new_lead`, `new_booking`, `booking_cancelled`

Example Request

{
  "url": "https://your-app.com/webhook",
  "events": ["new_call", "missed_call"]
}

Response

// 201 Created
{
  "data": {
    "id": "whk_2fc81fd8...",
    "url": "https://your-app.com/webhook",
    "events": ["new_call", "missed_call"],
    "created_at": "2026-04-11T22:09:48Z",
    "api_key_suffix": "****1e5f"
  }
}

DELETE /webhooks/{id}

Removes a registered webhook.

Path Parameters

Parameter	Type	Description
`id` REQUIRED	string	The webhook ID to delete

Response

// 200 OK
{
  "data": {
    "id": "whk_2fc81fd8...",
    "deleted": true
  }
}

Errors

The API returns standard HTTP status codes with descriptive error messages.

Error Response Format

{
  "error": {
    "status": 404,
    "message": "Call call_abc123 not found."
  }
}

Status Codes

Code	Meaning	Description
200	OK	Request succeeded
201	Created	Resource created successfully
400	Bad Request	Invalid request parameters
401	Unauthorized	Missing or invalid API key
404	Not Found	Resource does not exist
429	Rate Limited	Too many requests, slow down
500	Server Error	Internal server error

← Back to NeverMiss