Get conversation by ID

GET/v1/conversations/{convID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

convIDstringrequired

Conversation ID

Responses

200OK

ai_handoff_packageAIHandoffPackageItem

Show properties

actions_takenanyrequired

agent_idstring

created_atstringrequired

customer_contextanyrequired

detected_intentstringrequired

handoff_reasonstringrequired

idstringrequired

next_best_actionstringrequired

retrieved_sourcesanyrequired

run_idstring

sentimentanyrequired

statusstringrequired

summarystringrequired

ai_modestring | nullrequired

assigned_agent_idstring | nullrequired

assigned_atstring | nullrequired

channel_idstringrequired

closed_atstring | nullrequired

contact_idstringrequired

contact_namestring

contact_phonestring

created_atstringrequired

idstringrequired

last_message_atstring | nullrequired

last_message_directionstring | nullrequired

last_message_previewstring | nullrequired

metadataanyrequired

organization_idstringrequired

statusstringrequired

unread_countinteger<int32>required

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/conversations/string"

const response = await fetch("/v1/conversations/string", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/conversations/string",
)

Response

{
  "ai_handoff_package": {
    "actions_taken": "string",
    "agent_id": "string",
    "created_at": "string",
    "customer_context": "string",
    "detected_intent": "string",
    "handoff_reason": "string",
    "id": "string",
    "next_best_action": "string",
    "retrieved_sources": "string",
    "run_id": "string",
    "sentiment": "string",
    "status": "string",
    "summary": "string"
  },
  "ai_mode": "string",
  "assigned_agent_id": "string",
  "assigned_at": "string",
  "channel_id": "string",
  "closed_at": "string",
  "contact_id": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "created_at": "string",
  "id": "string",
  "last_message_at": "string",
  "last_message_direction": "string",
  "last_message_preview": "string",
  "metadata": "string",
  "organization_id": "string",
  "status": "string",
  "unread_count": 0,
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}