Get conversation — Brigg developers

Access & visibility

Allow support.GetConversation on your API key. Resource read permissions: core:Conversation.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:Conversation record. Find it with support.ListConversations. Use the record's top-level id, not a business field or account ID.

Response

Returns 200 OK with a JSON body.

item: null means there is no matching record visible to this caller. It does not reveal whether an inaccessible record exists.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

itemConversationRecordRequired

null when no such record

ConversationRecord

idstringRequired

Stable core:Conversation record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataConversationRequired

The record's fields.

Conversation

Conversation4 fields

subjectstringOptional

Conversation subject shown to the support team.

statusstringOptional

Current case state. Resolved and closed are distinct stored states; use the value returned by the API.

Allowed: "new", "open", "pending", "escalated", "snoozed", "resolved", "closed".

channelstringOptional

Channel through which this conversation arrived.

Allowed: "email", "web_chat", "contact_form", "sms", "phone".

snippetstringOptional

Short preview of the conversation's latest message.

Relationships and assignment5 fields

inbox_refstringOptional

ID of a core:Inbox record. Find it with support.ListInboxes and use the top-level id. This is not an account ID or a display name.

contact_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

company_refstringOptional

ID of a core:Company record. Find it with customers.ListCompanies and use the top-level id. This is not an account ID or a display name.

assignee_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

tagsarray of stringOptional

Stable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.

Activity2 fields

last_message_atnumberOptional

Most recent message time in Unix milliseconds.

first_response_atnumberOptional

First response time in Unix milliseconds, when a response has been recorded.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Conversation` record. Find it with [support.ListConversations](/reference/support/ListConversations). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_conversation_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Conversation record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "inbox_ref": {
              "type": "string",
              "description": "ID of a `core:Inbox` record. Find it with [support.ListInboxes](/reference/support/ListInboxes) and use the top-level `id`. This is not an account ID or a display name."
            },
            "subject": {
              "type": "string",
              "description": "Conversation subject shown to the support team."
            },
            "contact_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "company_ref": {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
            },
            "status": {
              "type": "string",
              "enum": [
                "new",
                "open",
                "pending",
                "escalated",
                "snoozed",
                "resolved",
                "closed"
              ],
              "description": "Current case state. Resolved and closed are distinct stored states; use the value returned by the API."
            },
            "assignee_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "channel": {
              "type": "string",
              "enum": [
                "email",
                "web_chat",
                "contact_form",
                "sms",
                "phone"
              ],
              "description": "Channel through which this conversation arrived."
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
            },
            "snippet": {
              "type": "string",
              "description": "Short preview of the conversation's latest message."
            },
            "last_message_at": {
              "type": "number",
              "description": "Most recent message time in Unix milliseconds."
            },
            "first_response_at": {
              "type": "number",
              "description": "First response time in Unix milliseconds, when a response has been recorded."
            }
          },
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Conversation"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "ConversationRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_conversation_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "inbox_ref": "e_inbox_support",
          "subject": "Help with onboarding",
          "contact_ref": "e_person_alex",
          "status": "open",
          "channel": "email",
          "snippet": "Can you help us import our contacts?",
          "last_message_at": 1791279900000
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.GetConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_conversation_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/support.GetConversation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_conversation_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_conversation_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetConversation",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/support.GetConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_conversation_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/support.GetConversation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_conversation_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_conversation_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetConversation",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_conversation_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "inbox_ref": "e_inbox_support",
      "subject": "Help with onboarding",
      "contact_ref": "e_person_alex",
      "status": "open",
      "channel": "email",
      "snippet": "Can you help us import our contacts?",
      "last_message_at": 1791279900000
    }
  }
}

Illustrative values, not a live response.

A missing or inaccessible record returns item: null. Do not treat this as proof that a record exists for another member.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.GetConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_conversation_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/support.GetConversation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_conversation_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_conversation_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetConversation",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/support.GetConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_conversation_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/support.GetConversation", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_conversation_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_conversation_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetConversation",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": null
}

Illustrative values, not a live response.