Skip to main content
GET
/
conversations
List conversations
curl --request GET \
  --url https://api.getarbol.com/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "requestId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Query Parameters

​
limit
integer
default:50

Max items to return (1-100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Items to skip

Required range: x >= 0
​
agentId
string

Filter by agent ID

​
contactId
string

Filter by contact ID

​
status
enum<string>

Filter by status

Available options:
PENDING,
IN_PROGRESS,
SUCCESS,
FAILED,
UNKNOWN,
NO_ANSWER,
VOICEMAIL
​
direction
enum<string>

Filter by direction

Available options:
INBOUND,
OUTBOUND
​
channel
enum<string>

Filter by channel

Available options:
VOICE,
CHAT,
SMS
​
search
string

Search text

​
startDate
string<date-time>

Filter from date (ISO 8601)

​
endDate
string<date-time>

Filter to date (ISO 8601)

Response

List of conversations