Skip to main content
GET
/
v1
/
conversation
/
{id}
Get conversation details
curl --request GET \
  --url https://connect.provisionapp.io/v1/conversation/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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",
  "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>"
  ]
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string<uuid>
required
Example:

"57f2d879-20f8-4106-9abb-44fa099e0448"

Query Parameters

​
include
string

Comma-separated relations to expand

Example:

"sites,participants,requester,labels,assignee,conversationAssigneeGroup"

Response

Conversation details

​
id
string<uuid>
required
​
friendlyId
string
required
​
subject
string
required
​
type
enum<string> | null
required
Available options:
support_ticket,
member_services,
non_support_event,
null
​
snoozeUntil
string<date-time> | null
required
​
createdAt
string<date-time>
required
​
deletedAt
string<date-time> | null
required
​
assigneeGroupUpdatedAt
string<date-time> | null
required
​
assigneeUpdatedAt
string<date-time> | null
required
​
conversationStatusUpdatedAt
string<date-time> | null
required
​
lastMessageReceivedAt
string<date-time> | null
required
​
requesterUpdatedAt
string<date-time> | null
required
​
status
enum<string> | null
required
Available options:
new,
open,
snoozed,
on_hold,
solved,
closed,
null
​
urgency
enum<string> | null
required
Available options:
urgent,
normal,
low,
life_safety,
null
​
sites
object[] | null
​
assigneeId
string | null
​
assignee
object
​
conversationAssigneeGroupId
string<uuid> | null
​
conversationAssigneeGroup
object
​
requesterId
string<uuid> | null
​
requester
object
​
participants
object · object · null[] | null
​
labels
string[] | null