conversation
Get conversation context
Return the contextual data attached to a conversation (notes, key-value attributes, and related entities) without re-fetching the conversation itself. Useful when your integration already has the conversation row cached and only needs the side data. Requires the conversation:read scope.
GET
/
v1
/
conversation
/
{id}
/
context
Get conversation context
curl --request GET \
--url https://connect.provisionapp.io/v1/conversation/{id}/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://connect.provisionapp.io/v1/conversation/{id}/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://connect.provisionapp.io/v1/conversation/{id}/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"subject": "<string>",
"messages": [
{
"author": "<string>",
"role": "<string>",
"createdAt": "<string>",
"text": "<string>",
"isInternal": true,
"rawBody": "<string>",
"attachments": [
{
"type": "<string>",
"title": "<string>",
"content": "<string>",
"transcriptionId": "<string>"
}
]
}
],
"status": "<string>",
"type": "<string>",
"urgency": "<string>",
"labels": [
"<string>"
],
"requester": "<string>",
"participants": {
"agents": [
"<string>"
],
"clients": [
{
"name": "<string>",
"primaryPhoneNumber": "<string>",
"primaryEmail": "<string>"
}
]
},
"sites": [
{
"address": "<string>",
"serviceLevel": "<string>",
"id": "<string>",
"associatedConversations": [
{
"friendlyId": "<string>",
"subject": "<string>",
"status": "<string>",
"statusLastUpdatedAt": "<string>",
"issue": "<string>",
"resolution": "<string>",
"shortSummary": "<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
Send the API key in the x-api-key header.
Path Parameters
Example:
"57f2d879-20f8-4106-9abb-44fa099e0448"
⌘I
Get conversation context
curl --request GET \
--url https://connect.provisionapp.io/v1/conversation/{id}/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://connect.provisionapp.io/v1/conversation/{id}/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://connect.provisionapp.io/v1/conversation/{id}/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"subject": "<string>",
"messages": [
{
"author": "<string>",
"role": "<string>",
"createdAt": "<string>",
"text": "<string>",
"isInternal": true,
"rawBody": "<string>",
"attachments": [
{
"type": "<string>",
"title": "<string>",
"content": "<string>",
"transcriptionId": "<string>"
}
]
}
],
"status": "<string>",
"type": "<string>",
"urgency": "<string>",
"labels": [
"<string>"
],
"requester": "<string>",
"participants": {
"agents": [
"<string>"
],
"clients": [
{
"name": "<string>",
"primaryPhoneNumber": "<string>",
"primaryEmail": "<string>"
}
]
},
"sites": [
{
"address": "<string>",
"serviceLevel": "<string>",
"id": "<string>",
"associatedConversations": [
{
"friendlyId": "<string>",
"subject": "<string>",
"status": "<string>",
"statusLastUpdatedAt": "<string>",
"issue": "<string>",
"resolution": "<string>",
"shortSummary": "<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>"
}
}