Get a conversation

GET

conversations

{id}

Get a conversation

curl --request GET \
  --url https://api.getarbol.com/v1/conversations/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getarbol.com/v1/conversations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "channelKind": "voice",
  "closeReason": "completed",
  "contactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "createdAt": "2026-08-29T14:30:00Z",
  "direction": "inbound",
  "durationSeconds": 4503599627370495,
  "endedAt": "2026-08-29T14:30:00Z",
  "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "language": "<string>",
  "lastMessageAt": "2026-08-29T14:30:00Z",
  "messageCount": 4503599627370495,
  "originKind": "manual",
  "outcome": "success",
  "sentiment": "neutral",
  "startedAt": "2026-08-29T14:30:00Z",
  "status": "open",
  "subjectContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "summary": "<string>",
  "title": "<string>",
  "updatedAt": "2026-08-29T14:30:00Z",
  "lineAddress": "<string>",
  "facts": [
    {
      "confidence": 0.5,
      "definition": {
        "description": "<string>",
        "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
        "identifier": "<string>",
        "kind": "attribute",
        "subjectKind": "contact",
        "valueType": "option"
      },
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "observedAt": "2026-08-29T14:30:00Z",
      "reason": "<string>",
      "recordedAt": "2026-08-29T14:30:00Z",
      "setBy": "user",
      "subject": {
        "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
        "type": "contact"
      },
      "value": {
        "type": "text",
        "value": "<string>"
      },
      "verificationStatus": "unreviewed"
    }
  ],
  "messages": [
    {
      "content": "<string>",
      "contentFormat": "text",
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "occurredAt": "2026-08-29T14:30:00Z",
      "payload": {
        "interrupted": true,
        "latency": {
          "e2eMs": 4503599627370495,
          "llmMs": 4503599627370495,
          "llmTtfbMs": 4503599627370495,
          "sttMs": 4503599627370495,
          "ttsMs": 4503599627370495
        },
        "source": {
          "hasMedia": true,
          "kind": "text",
          "transcribed": true
        },
        "sourceMedium": "<string>",
        "tool": {
          "name": "<string>",
          "status": "completed",
          "input": "<string>",
          "latencyMs": 4503599627370495,
          "output": "<string>",
          "truncated": true
        }
      },
      "role": "contact",
      "seq": 4503599627370495
    }
  ],
  "participants": [
    {
      "contactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "name": "<string>",
      "phone": "<string>",
      "roles": [
        "caller"
      ]
    }
  ]
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "code": "custom",
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Path Parameters

string

required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

Query Parameters

expand

enum<string>[]

Maximum array length: 3

Available options:

messages,

participants,

facts

Response

agentId

string | null

required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

channelKind

enum<string>

required

Conversation transport family.

Available options:

voice,

whatsapp,

web

Example:

"voice"

closeReason

enum<string> | null

required

Reason recorded when a Conversation enters its closed state.

Available options:

completed,

inactivity,

handoff,

provider_migration,

error,

manual

Example:

"completed"

contactId

string | null

required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

createdAt

string<date-time>

required

ISO 8601 timestamp with an explicit UTC offset.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

direction

enum<string>

required

Direction of a Conversation relative to the organization.

Available options:

inbound,

outbound

Example:

"inbound"

durationSeconds

integer | null

required

Required range: 0 <= x <= 9007199254740991

endedAt

string<date-time> | null

required

ISO 8601 timestamp with an explicit UTC offset.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

string

required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

language

string | null

required

Maximum string length: 35

lastMessageAt

string<date-time> | null

required

ISO 8601 timestamp with an explicit UTC offset.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

messageCount

integer

required

Required range: 0 <= x <= 9007199254740991

originKind

enum<string>

required

Source that created the Conversation record.

Available options:

inbound,

manual,

automation,

import,

test

Example:

"manual"

outcome

enum<string> | null

required

Success evaluation aggregated from the applicable Conversation assessment criteria.

Available options:

success,

failure,

unknown

Example:

"success"

sentiment

enum<string> | null

required

Coarse sentiment assigned to a Conversation.

Available options:

positive,

neutral,

negative

Example:

"neutral"

startedAt

string<date-time>

required

ISO 8601 timestamp with an explicit UTC offset.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

status

enum<string>

required

Durable lifecycle state of a Conversation.

Available options:

open,

closed

Example:

"open"

subjectContactId

string | null

required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

summary

string | null

required

Maximum string length: 8000

title

string | null

required

Display title. Non-test messaging conversations receive an early channel fallback, refined from the first substantive inbound; closure analysis may enrich it. Explicit human titles are preserved.

Maximum string length: 500

updatedAt

string<date-time>

required

ISO 8601 timestamp with an explicit UTC offset.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

lineAddress

string | null

required

The organization's own address on this channel, when known.

Maximum string length: 320

facts

Fact assertion · object[]

Maximum array length: 100

Show child attributes

messages

object[]

Maximum array length: 1000

Show child attributes

participants

Conversation participant · object[]

Maximum array length: 20

Show child attributes

Get a conversation

curl --request GET \
  --url https://api.getarbol.com/v1/conversations/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getarbol.com/v1/conversations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "channelKind": "voice",
  "closeReason": "completed",
  "contactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "createdAt": "2026-08-29T14:30:00Z",
  "direction": "inbound",
  "durationSeconds": 4503599627370495,
  "endedAt": "2026-08-29T14:30:00Z",
  "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "language": "<string>",
  "lastMessageAt": "2026-08-29T14:30:00Z",
  "messageCount": 4503599627370495,
  "originKind": "manual",
  "outcome": "success",
  "sentiment": "neutral",
  "startedAt": "2026-08-29T14:30:00Z",
  "status": "open",
  "subjectContactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
  "summary": "<string>",
  "title": "<string>",
  "updatedAt": "2026-08-29T14:30:00Z",
  "lineAddress": "<string>",
  "facts": [
    {
      "confidence": 0.5,
      "definition": {
        "description": "<string>",
        "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
        "identifier": "<string>",
        "kind": "attribute",
        "subjectKind": "contact",
        "valueType": "option"
      },
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "observedAt": "2026-08-29T14:30:00Z",
      "reason": "<string>",
      "recordedAt": "2026-08-29T14:30:00Z",
      "setBy": "user",
      "subject": {
        "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
        "type": "contact"
      },
      "value": {
        "type": "text",
        "value": "<string>"
      },
      "verificationStatus": "unreviewed"
    }
  ],
  "messages": [
    {
      "content": "<string>",
      "contentFormat": "text",
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "occurredAt": "2026-08-29T14:30:00Z",
      "payload": {
        "interrupted": true,
        "latency": {
          "e2eMs": 4503599627370495,
          "llmMs": 4503599627370495,
          "llmTtfbMs": 4503599627370495,
          "sttMs": 4503599627370495,
          "ttsMs": 4503599627370495
        },
        "source": {
          "hasMedia": true,
          "kind": "text",
          "transcribed": true
        },
        "sourceMedium": "<string>",
        "tool": {
          "name": "<string>",
          "status": "completed",
          "input": "<string>",
          "latencyMs": 4503599627370495,
          "output": "<string>",
          "truncated": true
        }
      },
      "role": "contact",
      "seq": 4503599627370495
    }
  ],
  "participants": [
    {
      "contactId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "name": "<string>",
      "phone": "<string>",
      "roles": [
        "caller"
      ]
    }
  ]
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "code": "custom",
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "<string>",
  "data": "<unknown>"
}

Overview

Endpoints

Get a conversation

Authorizations

Path Parameters

Query Parameters

Response