GET
/
api
/
v1
/
conversations
List conversations
curl --request GET \
  --url https://api.fleetworks.ai/api/v1/conversations \
  --header 'Authorization: Bearer <token>'
{
  "conversations": [
    {
      "id": 123,
      "type": "call",
      "createdAt": "2023-11-07T05:31:56Z",
      "mcNumber": "<string>",
      "dotNumber": 123,
      "carrierHwConnectionStatus": "<string>",
      "carrierHwRulesAssessment": "<string>",
      "fromPhone": "<string>",
      "callerName": "<string>",
      "callerExt": "<string>",
      "callSummary": "<string>",
      "callContentTags": "<string>",
      "emailSubject": "<string>",
      "emailFrom": "<string>",
      "loads": "<string>",
      "totalBids": 123,
      "bidAmounts": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.

Query Parameters

​
startTime
string<date>
required

Start time for conversation list in ISO8601 format

​
endTime
string<date>
required

End time for conversation list in ISO8601 format

​
loadId
string

Optional load ID to filter conversations

​
mcNumber
string

Optional MC number to filter conversations

​
origin
string

Optional load's origin pickup address to filter conversations

​
destination
string

Optional load's destination dropoff address to filter conversations

​
offset
number
default:0

Pagination offset

Required range: x >= 0
​
limit
number
default:100

Pagination limit

Required range: 1 <= x <= 500

Response

200
application/json

Success

The response is of type object.