Skip to main content
GET
/
conversations
List Conversations
curl --request GET \
  --url https://api.revring.ai/v1/conversations \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "agentName": "<string>",
      "channel": "sms",
      "agentAddress": "<string>",
      "senderAddress": "<string>",
      "messageCount": 123,
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "pageSize": 123,
  "total": 123,
  "hasNextPage": true
}

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Query Parameters

agentId
string
folderId
string

Filter by the agent's folder. A folder id, or 'none' for agents with no folder.

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:25
Required range: 1 <= x <= 100

Response

Conversation list page

data
object[]
page
integer
pageSize
integer
total
integer
hasNextPage
boolean