> ## Documentation Index
> Fetch the complete documentation index at: https://help.withallo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Integrate Allo's communication capabilities into your applications

The Allo API enables developers to integrate Allo's communication capabilities directly into their applications. Build CRM integrations, automate post-call workflows, sync conversation data, and power AI agents with your team's call and SMS history.

## Getting started

Before using the API, make sure you have:

* An active Allo subscription
* Admin or Manager permissions on your workspace
* An API key generated from [Settings > API](https://web.withallo.com/settings/api)

## API documentation

<CardGroup cols={2}>
  <Card title="Authentication" href="/en/v2/api-reference/guides/authentication">
    API key setup and scopes
  </Card>

  <Card title="Rate limits" href="/en/v2/api-reference/guides/rate-limits">
    Request limits and headers
  </Card>

  <Card title="Pagination" href="/en/v2/api-reference/guides/pagination">
    Page-based results with total counts
  </Card>

  <Card title="Error handling" href="/en/v2/api-reference/guides/error-handling">
    Error format and recovery
  </Card>
</CardGroup>

## Core capabilities

The API provides access to:

* **Conversations** — retrieve call and SMS history in a unified timeline, with keyword search across transcripts and message content
* **Webhooks** — receive real-time notifications when calls complete, messages arrive, tags are added, and contacts change
* **Phone numbers** — list your Allo numbers with capabilities, sender ID status, and member access
* **Users** — access your team roster with roles and assigned numbers
* **Tags** — discover available call tags for filtering and reporting

## Authentication

API keys are generated through your workspace settings. Include the key in the `Authorization` header of every request:

```bash theme={null}
curl -X GET "https://api.withallo.com/v2/api/conversations" \
  -H "Authorization: Api-Key ak_live_your_key_here"
```

Store your API key securely. Do not expose it in client-side code or public repositories.

## Rate limiting

Rate limits vary by request type:

| Operation                                 | Limit              |
| ----------------------------------------- | ------------------ |
| Read requests (GET)                       | 20 requests/second |
| Write requests (POST, PUT, PATCH, DELETE) | 5 requests/second  |

Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers so you can monitor your usage. See [Rate limits](/en/v2/api-reference/guides/rate-limits) for details.

## Quick example

Get your recent conversations:

```bash theme={null}
curl -X GET "https://api.withallo.com/v2/api/conversations?size=5" \
  -H "Authorization: Api-Key ak_live_your_key_here"
```

```json theme={null}
{
  "data": [
    {
      "contact_number": "+14155551234",
      "contacts": [{ "id": "cnt-abc", "name": "Sarah Johnson", "company": { "name": "Acme Corp" } }],
      "last_activity": "2026-04-21T14:30:00Z",
      "last_item": { "id": "cll-abc123", "type": "CALL", "direction": "INBOUND", "result": "ANSWERED", "summary": "Customer called about upgrading their plan.", "duration": 145 }
    }
  ],
  "pagination": { "page": 1, "size": 5, "total_count": 156, "has_more": true }
}
```

## Endpoints

<CardGroup cols={2}>
  <Card title="Conversations" icon="https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Phone.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=83bbcaf90dae5f30887cdfbc503d97b2" href="/en/v2/api-reference/conversations/overview" width="24" height="24" data-path="media/allo-icons/Phone.svg">
    Unified call + SMS timeline with date filtering, keyword search, and rich contact data
  </Card>

  <Card title="Webhooks" icon="https://mintcdn.com/themobilefirstcompany/0w3bVWjKfZPY4i7y/media/integrations/Webhooks.svg?fit=max&auto=format&n=0w3bVWjKfZPY4i7y&q=85&s=d2fc254143963c5ea1caa09b613bd22e" href="/en/v2/api-reference/webhooks/overview" width="24" height="24" data-path="media/integrations/Webhooks.svg">
    Real-time event notifications with HMAC signatures and automatic retries
  </Card>

  <Card title="Phone Numbers" icon="https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Phone.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=83bbcaf90dae5f30887cdfbc503d97b2" href="/en/v2/api-reference/phone-numbers/overview" width="24" height="24" data-path="media/allo-icons/Phone.svg">
    Your Allo numbers with capabilities, sender ID status, and member access
  </Card>

  <Card title="Users" icon="https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Contacts.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=21e8763f48b29af6190da3bcc331ba89" href="/en/v2/api-reference/users/overview" width="24" height="24" data-path="media/allo-icons/Contacts.svg">
    Team roster with roles and assigned numbers
  </Card>

  <Card title="Tags" icon="https://mintcdn.com/themobilefirstcompany/yN5XCm7zDDPr0-yn/media/allo-icons/chat-bubble.svg?fit=max&auto=format&n=yN5XCm7zDDPr0-yn&q=85&s=d1817ba8f8b3a0d440cf67199eb899cd" href="/en/v2/api-reference/tags/overview" width="24" height="24" data-path="media/allo-icons/chat-bubble.svg">
    Available call tags for filtering conversations
  </Card>
</CardGroup>