List conversations

GET

conversation

list

List conversations

curl --request GET \
  --url https://connect.provisionapp.io/v1/conversation/list \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/conversation/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "friendlyId": "<string>",
      "subject": "<string>",
      "snoozeUntil": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "assigneeGroupUpdatedAt": "2023-11-07T05:31:56Z",
      "assigneeUpdatedAt": "2023-11-07T05:31:56Z",
      "conversationStatusUpdatedAt": "2023-11-07T05:31:56Z",
      "lastMessageReceivedAt": "2023-11-07T05:31:56Z",
      "requesterUpdatedAt": "2023-11-07T05:31:56Z",
      "customProperties": {
        "warranty_count": 5,
        "region": "east",
        "onsite_required": true
      },
      "sites": [
        {
          "id": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "tosAccepted": "<string>",
          "clientSegment": "<string>",
          "cppExpDate": "2023-11-07T05:31:56Z",
          "businessName": "<string>",
          "brandId": "<string>",
          "primaryClientId": "<string>",
          "primaryProjectId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "sla": 123,
          "isMonitored": true
        }
      ],
      "assigneeId": "<string>",
      "assignee": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "conversationAssigneeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversationAssigneeGroup": {
        "conversationAssigneeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "requesterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requester": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identityId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
      },
      "participants": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identityId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>"
        }
      ],
      "labels": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Send the API key in the x-api-key header.

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

offset

integer | null

default:0

Required range: x >= 0

string

include

string

filters

string

A URL-encoded JSON array of filter conditions, all AND-ed together. Each condition is { "attribute", "operator", "value", "valueType"? }. Allowed attributes: id, type, status, urgency, assigneeId, conversationAssigneeGroupId, requesterId, createdAt. Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >, >=, is_null, is_not_null. value is always a string; set valueType (one of boolean, number, number[], string, string[]) to coerce it — e.g. "boolean" for a true/false attribute or "string[]" for the in operator.

sort

string

Comma-separated list of fields to sort by, applied in order; prefix a field with - for descending. Allowed fields: createdAt, lastMessageReceivedAt, subject, status, urgency.

Response

Paginated list of conversations

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

List conversations

curl --request GET \
  --url https://connect.provisionapp.io/v1/conversation/list \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/conversation/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "friendlyId": "<string>",
      "subject": "<string>",
      "snoozeUntil": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "assigneeGroupUpdatedAt": "2023-11-07T05:31:56Z",
      "assigneeUpdatedAt": "2023-11-07T05:31:56Z",
      "conversationStatusUpdatedAt": "2023-11-07T05:31:56Z",
      "lastMessageReceivedAt": "2023-11-07T05:31:56Z",
      "requesterUpdatedAt": "2023-11-07T05:31:56Z",
      "customProperties": {
        "warranty_count": 5,
        "region": "east",
        "onsite_required": true
      },
      "sites": [
        {
          "id": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "tosAccepted": "<string>",
          "clientSegment": "<string>",
          "cppExpDate": "2023-11-07T05:31:56Z",
          "businessName": "<string>",
          "brandId": "<string>",
          "primaryClientId": "<string>",
          "primaryProjectId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "sla": 123,
          "isMonitored": true
        }
      ],
      "assigneeId": "<string>",
      "assignee": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "conversationAssigneeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversationAssigneeGroup": {
        "conversationAssigneeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "requesterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requester": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identityId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
      },
      "participants": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "identityId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>"
        }
      ],
      "labels": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

system

site

conversation

client

user

Authorizations

Query Parameters

Response