Get inbox — Brigg developers

Access & visibility

Allow support.GetInbox on your API key. Resource read permissions: core:Inbox.

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:Inbox record. Find it with support.ListInboxes. 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.

itemInboxRecordRequired

null when no such record

InboxRecord

idstringRequired

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

dataInboxRequired

The record's fields.

Inbox

Inbox5 fields

namestringRequired

Team inbox display name.

slugstringOptional

Stable URL segment identifying this item.

Pattern: ^[a-z][a-z0-9-]*$.

descriptionstringOptional

Purpose and scope of the team inbox.

purposestringOptional

Whether the inbox handles customer support or reception.

Allowed: "support", "reception".

accentstringOptional

Display color token; it does not change routing or access.

Allowed: "green", "blue", "amber", "violet", "neutral".

Assignment3 fields

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

auto_assign_on_replybooleanOptional

Whether the first member reply assigns an unassigned conversation to that member.

round_robinbooleanOptional

Saved round-robin preference. This setting does not currently cause automatic assignment.

Agent instructions5 fields

agent_first_emailbooleanOptional

Whether the inbox agent takes the first turn on incoming email before escalating work to a person.

agent_first_web_chatbooleanOptional

Whether the inbox agent takes the first turn on incoming web chat before escalating work to a person.

playbook_mdstringOptional

Shared answering and escalation instructions in Markdown.

voice_playbook_mdstringOptional

Additional instructions for spoken phone conversations; the shared playbook still applies.

doc_foldersarray of objectOptional

Document folders made available as reference material to this inbox.

Item fields

scopestringOptional

Document collection scope containing the folder.

pathstringOptional

Path to the folder within the document collection.

Customer experience2 fields

signature_mdstringOptional

Markdown footer appended to outgoing replies from this inbox.

web_chat_welcomestringOptional

Welcome message shown to web chat visitors. Empty or absent uses the localized default.

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:Inbox` record. Find it with [support.ListInboxes](/reference/support/ListInboxes). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_inbox_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Inbox 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": {
            "name": {
              "type": "string",
              "description": "Team inbox display name."
            },
            "slug": {
              "type": "string",
              "pattern": "^[a-z][a-z0-9-]*$",
              "description": "Stable URL segment identifying this item."
            },
            "description": {
              "type": "string",
              "description": "Purpose and scope of the team inbox."
            },
            "purpose": {
              "type": "string",
              "enum": [
                "support",
                "reception"
              ],
              "description": "Whether the inbox handles customer support or reception."
            },
            "accent": {
              "type": "string",
              "enum": [
                "green",
                "blue",
                "amber",
                "violet",
                "neutral"
              ],
              "description": "Display color token; it does not change routing or access."
            },
            "default_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."
            },
            "auto_assign_on_reply": {
              "type": "boolean",
              "description": "Whether the first member reply assigns an unassigned conversation to that member."
            },
            "agent_first_email": {
              "type": "boolean",
              "description": "Whether the inbox agent takes the first turn on incoming email before escalating work to a person."
            },
            "agent_first_web_chat": {
              "type": "boolean",
              "description": "Whether the inbox agent takes the first turn on incoming web chat before escalating work to a person."
            },
            "round_robin": {
              "type": "boolean",
              "description": "Saved round-robin preference. This setting does not currently cause automatic assignment."
            },
            "playbook_md": {
              "type": "string",
              "description": "Shared answering and escalation instructions in Markdown."
            },
            "voice_playbook_md": {
              "type": "string",
              "description": "Additional instructions for spoken phone conversations; the shared playbook still applies."
            },
            "signature_md": {
              "type": "string",
              "description": "Markdown footer appended to outgoing replies from this inbox."
            },
            "web_chat_welcome": {
              "type": "string",
              "description": "Welcome message shown to web chat visitors. Empty or absent uses the localized default."
            },
            "doc_folders": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "scope": {
                    "type": "string",
                    "description": "Document collection scope containing the folder."
                  },
                  "path": {
                    "type": "string",
                    "description": "Path to the folder within the document collection."
                  }
                },
                "additionalProperties": false
              },
              "description": "Document folders made available as reference material to this inbox."
            }
          },
          "required": [
            "name"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Inbox"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "InboxRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_inbox_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "name": "Customer support",
          "slug": "support",
          "purpose": "support",
          "auto_assign_on_reply": true,
          "playbook_md": "Answer product questions. Escalate billing disputes to a person."
        }
      }
    }
  ]
}

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

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/support.GetInbox", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_inbox_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_inbox_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInbox",
    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.GetInbox' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_inbox_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.GetInbox", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_inbox_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_inbox_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.GetInbox",
    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_inbox_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "name": "Customer support",
      "slug": "support",
      "purpose": "support",
      "auto_assign_on_reply": true,
      "playbook_md": "Answer product questions. Escalate billing disputes to a person."
    }
  }
}

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

TypeScript

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