GET
/
conversations
curl --request GET \
  --url https://api.operator.xyz/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Operator-Version: <operator-version>'
{
  "data": [
    {
      "id": "<string>",
      "livemode": true,
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "direction": "inbound",
      "phone_no": "<string>",
      "status": "queued",
      "transferred": true,
      "postprocessed": true,
      "postprocessed_at": "2023-11-07T05:31:56Z",
      "duration_sec": 123,
      "sentiment": "<string>",
      "zendesk_ticket_id": "<string>",
      "scenarios": [
        "<string>"
      ],
      "custom_fields": {}
    }
  ],
  "cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Operator-Version
string
required

The API version to use.

Example:

"2024-11-11"

Query Parameters

​
operator_id
string
required

The ID of the Operator that handled the conversation.

​
cursor
string

Cursor to paginate through the conversations.

​
created_at_gte
string

Filter conversations created after this date.

​
created_at_lt
string

Filter conversations created before this date.

​
completed_at_gte
string

Filter conversations completed after this date.

​
completed_at_lt
string

Filter conversations completed before this date.

​
postprocessed_at_gte
string

Filter conversations postprocessed after this date.

​
postprocessed_at_lt
string

Filter conversations postprocessed before this date.

Response

200 - application/json
List of conversations.

The response is of type object.