List inbox support addresses — Brigg developers

Access & visibility

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

inbox_idstringRequired

Use the support inbox record's top-level id, not its slug or forwarding address. support.ListInboxes.

At least 1 character.

Verify forwarding before using a support address

Get the inbox_id and forwarding address from List inbox channels. Configure your mail provider to forward the public support address into that inbox, then add the address. Adding it sends a verification email; the address becomes verified only when that email is forwarded back into the correct Brigg inbox.

List support addresses to check verified_at. A test=sent response only confirms a send attempt; it is not verification. Only the newest test can verify, and it expires after 24 hours. Fix forwarding before requesting another test. Verification permits that address to be used as Reply-To for its conversations; it does not change the authenticated sender.

Removing the address withdraws its verified Reply-To use. It does not remove your mail provider's forwarding rule or delete the inbox and its conversations. Change provider forwarding separately when retiring the address.

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 addressRequired

Additional support addresses configured for the selected inbox. This operation has no cursor pagination.

Item fields

idstringRequired

Additional address id from ListInboxSupportAddresses.items for this same inbox_id. It is not the email address, inbox ID, or a verification token.

addressstringRequired

Normalized additional public support email address, distinct from Brigg's generated inbox-forwarding address.

created_atnumberRequired

Unix millisecond timestamp when this address was added.

verified_atnumber or nullRequired

Unix millisecond time a valid test returned through this inbox, or null while unverified.

test_sent_atnumber or nullRequired

Unix millisecond time the newest test was sent, or null if no test has been sent. This does not prove verification.

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": {
    "inbox_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use the support inbox record's top-level id, not its slug or forwarding address. [support.ListInboxes](/reference/support/ListInboxes)."
    }
  },
  "required": [
    "inbox_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "inbox_id": "e_inbox_support"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Additional address id from ListInboxSupportAddresses.items for this same inbox_id. It is not the email address, inbox ID, or a verification token.",
            "examples": [
              "address_support"
            ]
          },
          "address": {
            "type": "string",
            "description": "Normalized additional public support email address, distinct from Brigg's generated inbox-forwarding address.",
            "examples": [
              "help@example.com"
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Unix millisecond timestamp when this address was added.",
            "examples": [
              1794301200000
            ]
          },
          "verified_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Unix millisecond time a valid test returned through this inbox, or null while unverified.",
            "examples": [
              1794301260000
            ]
          },
          "test_sent_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Unix millisecond time the newest test was sent, or null if no test has been sent. This does not prove verification.",
            "examples": [
              1794301200000
            ]
          }
        },
        "required": [
          "id",
          "address",
          "created_at",
          "verified_at",
          "test_sent_at"
        ],
        "additionalProperties": false,
        "title": "Support address"
      },
      "description": "Additional support addresses configured for the selected inbox. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "id": "isa_help",
          "address": "help@example.com",
          "created_at": 1794301200000,
          "verified_at": 1794301260000,
          "test_sent_at": 1794301200000
        },
        {
          "id": "isa_billing",
          "address": "billing@example.com",
          "created_at": 1794301200000,
          "verified_at": null,
          "test_sent_at": 1794301200000
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Only the first address has completed the return-mail check.

Request

cURL

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

TypeScript

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

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.ListInboxSupportAddresses", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "inbox_id": "e_inbox_support"
  }),
});
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 = {
  "inbox_id": "e_inbox_support"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.ListInboxSupportAddresses",
    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": "isa_help",
      "address": "help@example.com",
      "created_at": 1794301200000,
      "verified_at": 1794301260000,
      "test_sent_at": 1794301200000
    },
    {
      "id": "isa_billing",
      "address": "billing@example.com",
      "created_at": 1794301200000,
      "verified_at": null,
      "test_sent_at": 1794301200000
    }
  ]
}

Illustrative values, not a live response.

The inbox still has its normal Brigg forwarding address.

Request

cURL

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

TypeScript

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

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

Illustrative values, not a live response.