List Conversations | AgentPhone

const url = 'https://api.agentphone.ai/v1/conversations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "id": "string",
      "phoneNumberId": "string",
      "phoneNumber": "string",
      "participant": "string",
      "lastMessageAt": "2024-01-15T09:30:00Z",
      "lastMessagePreview": "string",
      "messageCount": 1,
      "createdAt": "2024-01-15T09:30:00Z",
      "agentId": "string",
      "channel": "native",
      "isGroup": false,
      "groupId": "string",
      "groupName": "string",
      "groupIconUrl": "string",
      "participants": [
        {
          "identifier": "string",
          "name": "string"
        }
      ],
      "metadata": {}
    }
  ],
  "hasMore": true,
  "total": 1
}

List all conversations for this account.

Sorted by most recent activity (lastMessageAt desc). total is served from a short per-account cache (app/services/conversation_totals.py); hasMore is computed from the page query itself.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional<=100Defaults to 20

offsetintegerOptional0-10000Defaults to 0

Response

Successful Response

datalist of objects

hasMoreboolean

totalinteger

Total conversations for this account; may be up to a few minutes old (cached per account, default five minutes). Use hasMore for pagination.

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors