Get conversation details

GET

conversation

{id}

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

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

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

{
  "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>"
  ]
}

{
  "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.

Path Parameters

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

string

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

customProperties

object

required

Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here — call the custom-property list endpoint to resolve an id to its name and type. A property never given a value takes the default configured for it, and is left out rather than returned as null when there is no default either. A value stored before its property was changed — an option renamed or removed, the type switched — is returned as stored, so it may not match the type the property has today; an absent key is the only reliable sign that nothing is set.

Show child attributes

Example:

{
  "warranty_count": 5,
  "region": "east",
  "onsite_required": true
}

sites

object[] | null

Show child attributes

assigneeId

string | null

assignee

object | null

Show child attributes

conversationAssigneeGroupId

string<uuid> | null

conversationAssigneeGroup

object | null

Show child attributes

requesterId

string<uuid> | null

requester

object

Option 1
Option 2

Show child attributes

participants

object · object · null[] | null

Option 1
Option 2

Show child attributes

labels

string[] | null

Get conversation details

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

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

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

{
  "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>"
  ]
}

{
  "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

Path Parameters

Query Parameters

Response