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

# Conversations

> List messaging conversations with your customers.

Returns SMS and messaging conversations for your business, sorted by most recent activity. Use the endpoint to mirror local customer conversations into your existing CRM or support system when you need a broader customer record.

NearIQ also computes dashboard activity snapshots in the background for local
CRM-style activity: leads, conversations, review requests, appointment
reminders, and webhook delivery health. Those snapshots contain only derived
counts, rates, and freshness metadata; raw webhook payloads and message bodies
remain in their source tables.

<ParamField header="X-NearIQ-Key" type="string" required>
  Your API key from Settings > API Keys.
</ParamField>

Required scope: `analytics:read`. Requires Growth plan or above.

## GET /api/v1/conversations

<RequestExample>
  ```bash cURL theme={null}
  curl "https://app.neariq.io/api/v1/conversations?status=open" \
    -H "X-NearIQ-Key: niq_your_key_here"
  ```
</RequestExample>

Query parameters:

| Parameter | Type   | Default | Description                                  |
| --------- | ------ | ------- | -------------------------------------------- |
| `status`  | string | `all`   | Filter by status: `open`, `closed`, or `all` |

```json theme={null}
{
  "conversations": [
    {
      "id": "e1f2a3b4-c5d6-7890-4567-901234567890",
      "customerName": "Mike Johnson",
      "customerPhone": "+15551234567",
      "channel": "sms",
      "status": "open",
      "lastMessageAt": "2026-05-10T13:45:00Z",
      "unreadCount": 2,
      "createdAt": "2026-05-08T10:00:00Z"
    }
  ],
  "stats": {
    "total": 18,
    "open": 7,
    "unread": 12
  },
  "_receipt": {
    "request_id": "req_abc123",
    "timestamp": "2026-05-10T14:30:00Z",
    "sha256": "e3b0c44298fc1c149afbf4c8996fb924..."
  }
}
```
