List inbox channels — Brigg developers

Access & visibility

Allow support.ListInboxChannels 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

No parameters. Send an empty JSON object ({}).

Connect your public support address

Use forward_address exactly as returned as the destination in your email provider’s forwarding rule. It is Brigg’s delivery address, not the address customers should necessarily use or the additional Reply-To address. Do not derive it from the inbox slug.

After forwarding is configured, add the public support address. That sends a verification email which must return through this inbox before the address can be used as Reply-To. Retain this row’s id as inbox_id for the support-address operations. Results are listed in inbox creation order and have no cursor.

Response

Returns 200 OK with a JSON body.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

itemsarray of Support inboxRequired

Support inboxes and their configured communication channels. This operation has no cursor pagination.

Item fields

idstringRequired

Inbox record ID used by support-address and phone configuration operations.

slugstringRequired

Inbox routing label. Use the complete returned forward_address rather than constructing an email address or URL from this value.

namestringRequired

Display name of the team's support inbox.

forward_addressstringRequired

Exact forwarding destination generated by Brigg for this inbox. Configure your email provider to forward the public support mailbox to this address.

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.
409	`org_not_provisioned`	Finish workspace inbox setup in Brigg before reading forwarding destinations.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Inbox record ID used by support-address and phone configuration operations.",
            "examples": [
              "inbox_support"
            ]
          },
          "slug": {
            "type": "string",
            "description": "Inbox routing label. Use the complete returned forward_address rather than constructing an email address or URL from this value.",
            "examples": [
              "support"
            ]
          },
          "name": {
            "type": "string",
            "description": "Display name of the team's support inbox.",
            "examples": [
              "Customer support"
            ]
          },
          "forward_address": {
            "type": "string",
            "description": "Exact forwarding destination generated by Brigg for this inbox. Configure your email provider to forward the public support mailbox to this address.",
            "examples": [
              "support@example.com"
            ]
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "forward_address"
        ],
        "additionalProperties": false,
        "title": "Support inbox"
      },
      "description": "Support inboxes and their configured communication channels. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "id": "e_inbox_support",
          "slug": "support",
          "name": "Customer support",
          "forward_address": "in.fictional.support@inbound.example.com"
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Forward your public help@example.com mailbox to the returned address, then verify it. This destination is fictional.

Request

cURL

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

TypeScript

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

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.ListInboxChannels", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
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 = {}
request = Request(
    "https://api.brigg.app/v1/operations/support.ListInboxChannels",
    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

{
  "items": [
    {
      "id": "e_inbox_support",
      "slug": "support",
      "name": "Customer support",
      "forward_address": "in.fictional.support@inbound.example.com"
    }
  ]
}

Illustrative values, not a live response.