Get inbox message — Brigg developers

Access & visibility

Allow support.GetInboxMessage on your API key. Resource read permissions: core:InboxMessage.

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:InboxMessage record. Use the relevant list operation to discover records. 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.

Messages are read-only through record operations. Creating a customer reply requires the supported messaging workflow, not writing a message record.

itemInboxMessageRecordRequired

null when no such record

InboxMessageRecord

idstringRequired

Stable core:InboxMessage 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.

dataInboxMessageRequired

The record's fields.

InboxMessage

Message7 fields

conversation_refstringRequired

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

sender_rolestringRequired

Who produced the message: customer contact, automated agent, workspace member or system.

Allowed: "contact", "agent", "member", "system".

sender_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.

channelstringOptional

Channel carrying the message. Internal notes use internal and are not customer replies.

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

directionstringOptional

Inbound from a customer, outbound to a customer, or internal to the support team.

Allowed: "inbound", "outbound", "internal".

bodystringOptional

Message content as stored for its channel.

eventstringOptional

System event associated with the message, when present.

Attachments1 fields

attachmentsarray of objectOptional

Attachments with a file ID, original filename and size in bytes.

Item fields

file_idstringOptional

File identifier.

filenamestringOptional

Original filename, including its extension.

sizenumberOptional

File size in bytes.

Delivery2 fields

deliverystringOptional

Recorded delivery state: queued, sent, delivered or failed. Sent does not guarantee receipt.

Allowed: "queued", "sent", "delivered", "failed".

delivery_reasonstringOptional

Reason reported for a delivery refusal or failure. Present only when a reason has been recorded.

Allowed: "empty", "not_a_number", "wrong_length", "unsupported_country", "needs_number_sender", "not_textable", "sms_not_configured", "quota_exceeded", "carrier_rejected", "email_bounced", "email_complaint".

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

List inbox messages

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:InboxMessage` record. Use the relevant list operation to discover records. Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_inboxmessage_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:InboxMessage 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": {
            "conversation_ref": {
              "type": "string",
              "description": "ID of a `core:Conversation` record. Find it with [support.ListConversations](/reference/support/ListConversations) and use the top-level `id`. This is not an account ID or a display name."
            },
            "sender_role": {
              "type": "string",
              "enum": [
                "contact",
                "agent",
                "member",
                "system"
              ],
              "description": "Who produced the message: customer contact, automated agent, workspace member or system."
            },
            "sender_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",
                "internal"
              ],
              "description": "Channel carrying the message. Internal notes use internal and are not customer replies."
            },
            "direction": {
              "type": "string",
              "enum": [
                "inbound",
                "outbound",
                "internal"
              ],
              "description": "Inbound from a customer, outbound to a customer, or internal to the support team."
            },
            "body": {
              "type": "string",
              "description": "Message content as stored for its channel."
            },
            "event": {
              "type": "string",
              "description": "System event associated with the message, when present."
            },
            "attachments": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "file_id": {
                    "type": "string",
                    "description": "File identifier."
                  },
                  "filename": {
                    "type": "string",
                    "description": "Original filename, including its extension."
                  },
                  "size": {
                    "type": "number",
                    "description": "File size in bytes."
                  }
                },
                "additionalProperties": false
              },
              "description": "Attachments with a file ID, original filename and size in bytes."
            },
            "delivery": {
              "type": "string",
              "enum": [
                "queued",
                "sent",
                "delivered",
                "failed"
              ],
              "description": "Recorded delivery state: queued, sent, delivered or failed. Sent does not guarantee receipt."
            },
            "delivery_reason": {
              "type": "string",
              "enum": [
                "empty",
                "not_a_number",
                "wrong_length",
                "unsupported_country",
                "needs_number_sender",
                "not_textable",
                "sms_not_configured",
                "quota_exceeded",
                "carrier_rejected",
                "email_bounced",
                "email_complaint"
              ],
              "description": "Reason reported for a delivery refusal or failure. Present only when a reason has been recorded."
            }
          },
          "required": [
            "conversation_ref",
            "sender_role"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "InboxMessage"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "InboxMessageRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_inboxmessage_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "conversation_ref": "e_conversation_onboarding",
          "sender_role": "contact",
          "channel": "email",
          "direction": "inbound",
          "body": "Can you help us import our contacts?"
        }
      }
    }
  ]
}

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.GetInboxMessage' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_inboxmessage_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/support.GetInboxMessage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_inboxmessage_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_inboxmessage_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInboxMessage",
    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.GetInboxMessage' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_inboxmessage_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.GetInboxMessage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_inboxmessage_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_inboxmessage_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInboxMessage",
    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_inboxmessage_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "conversation_ref": "e_conversation_onboarding",
      "sender_role": "contact",
      "channel": "email",
      "direction": "inbound",
      "body": "Can you help us import our contacts?"
    }
  }
}

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.GetInboxMessage' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_inboxmessage_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/support.GetInboxMessage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_inboxmessage_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_inboxmessage_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInboxMessage",
    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.GetInboxMessage' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_inboxmessage_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.GetInboxMessage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_inboxmessage_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_inboxmessage_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInboxMessage",
    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.