> For the complete documentation index, see [llms.txt](https://docs.limephone.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.limephone.io/api-reference.md).

# API Reference

The LimePhone API is a REST API for your LimePhone workspace: read call activity, recordings and AI summaries, send SMS, manage contacts and phone-number settings, and subscribe to webhooks. Every request is scoped to your organization by your API key — there is no separate account parameter.

## Base URL

```
https://dashboard.limephone.io/api/v1
```

Every request is HTTPS and every response is JSON.

## A first request

Create an API key in the dashboard (see Authentication), then list your most recent calls:

```bash
curl https://dashboard.limephone.io/api/v1/calls \
  -H "Authorization: Bearer sk_live_..."
```

```json
{
  "data": [
    {
      "id": 1204,
      "direction": "inbound",
      "fromNumber": "+14155550134",
      "toNumber": "+442080580300",
      "status": "completed",
      "duration": 184,
      "createdAt": "2026-09-04T09:12:44.000Z"
    }
  ],
  "pagination": { "page": 1, "limit": 50, "total": 1 }
}
```

## Resources

| Resource            | What it covers                                                                            |
| ------------------- | ----------------------------------------------------------------------------------------- |
| Calls               | Call history, recordings, transcriptions, AI summaries, voicemail, CRM outcome write-back |
| Messages            | Send and read SMS/MMS                                                                     |
| Contacts            | Your contact book, with automatic deduplication                                           |
| Phone numbers       | Your numbers and their routing settings                                                   |
| Users               | Organization members (read-only)                                                          |
| Webhooks            | Real-time event delivery with signed payloads                                             |
| Analytics & devices | Usage summaries and push-device tokens                                                    |

Questions or a missing endpoint you need? Email <support@limephone.io>.