Skip to content
Developers v1
API reference API keys

API reference

List inbox messages

support.ListInboxMessagesReadAPI key

List inbox messages visible to the credential, with filtering, sorting and cursor pagination.

POST/v1/operations/support.ListInboxMessages
On this page

Access & visibility

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

filtersarray of objectOptional

Conditions the row must ALL satisfy.

Item fields
fieldstringRequired

data.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.

Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.conversation_ref", "data.sender_role", "data.sender_ref", "data.channel", "data.direction", "data.body", "data.event", "data.attachments", "data.delivery", "data.delivery_reason".

opstringRequired

Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty.

Allowed: "eq", "neq", "contains", "starts_with", "gt", "gte", "lt", "lte", "in", "has", "is_empty", "is_not_empty".

valueJSON valueOptional

The comparison value; an array for in; omitted for is_empty / is_not_empty.

sortobjectOptional

Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker.

Nested fields
fieldstringRequired

data.<field> for a field of the record, or one of its own id, created_at, updated_at, created_by, private.

Allowed: "id", "created_at", "updated_at", "created_by", "private", "data.conversation_ref", "data.sender_role", "data.sender_ref", "data.channel", "data.direction", "data.body", "data.event", "data.attachments", "data.delivery", "data.delivery_reason".

directionstringOptional

Sort direction: asc for ascending or desc for descending.

Allowed: "asc", "desc".

limitintegerOptional

Maximum number of results to return in this page. Continue with next_cursor when returned.

Default: 100. Minimum: 1.

cursorstringOptional

The next_cursor of the previous page.

Filtering and sorting

All conditions are combined with AND. Address business fields as data.<field>, and record metadata as id, created_at, updated_at, created_by or private. A field path names one field; it does not traverse nested objects.

Operator Meaning Value
eq Equal to a scalar String, number, boolean or null
neq Not equal; missing values also match String, number, boolean or null
contains Case-insensitive text contains String; % and _ are literal characters
starts_with Case-insensitive text prefix String
gt, gte Greater than / at least Number or string appropriate to the field
lt, lte Less than / at most Number or string appropriate to the field
in Equal to any supplied scalar Nonempty array of strings, numbers, booleans or null
has Array contains a string One string; does not match properties inside array objects
is_empty Missing, null, empty string or empty array Omit value
is_not_empty Has a nonempty value Omit value

Match the stored field's type. Numeric business timestamps take Unix milliseconds; date-only business fields take YYYY-MM-DD. The record metadata fields created_at and updated_at also accept ISO timestamps for ordered comparisons.

Sorting defaults to updated_at descending. If you supply sort.field without sort.direction, direction is desc. The record ID breaks ties; missing values sort last.

Response

Returns 200 OK with a JSON body.

An empty items array means this page contains no matching visible results. Follow next_cursor when present.

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.

itemsarray of InboxMessageRecordRequired

Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned.

Item fields
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".

next_cursorstringOptional

Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results.

Pagination

Pass next_cursor from the response as cursor on the next request. Keep the same filters, sort and acting identity. Stop when next_cursor is absent; do not infer completion from the number of items. The default page size is 100; limit must be a positive integer.

Pagination is a live view, not a snapshot. Changes between pages can move records across page boundaries. Upsert by record ID rather than appending blindly. For recurring synchronization, use an overlapping update window and deduplicate records. Periodically reconcile IDs to detect deletions. Resource webhooks can supplement synchronization for eligible workspace-shared records only: they do not export private or project-scoped records. Personal data still needs polling and reconciliation.

const query = {
  "limit": 10
};
let cursor;
do {
  const response = await fetch("https://api.brigg.app/v1/operations/support.ListInboxMessages", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
  });
  const page = await response.json();
  if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
  for (const item of page.items) {
    console.log(item); // Process or upsert each result.
  }
  cursor = page.next_cursor;
} while (cursor);

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.
400 cursor_invalid Restart pagination with no cursor.
400 cursor_mismatch Use the cursor with the original filters, sort order and credential.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
            "enum": [
              "id",
              "created_at",
              "updated_at",
              "created_by",
              "private",
              "data.conversation_ref",
              "data.sender_role",
              "data.sender_ref",
              "data.channel",
              "data.direction",
              "data.body",
              "data.event",
              "data.attachments",
              "data.delivery",
              "data.delivery_reason"
            ]
          },
          "op": {
            "type": "string",
            "enum": [
              "eq",
              "neq",
              "contains",
              "starts_with",
              "gt",
              "gte",
              "lt",
              "lte",
              "in",
              "has",
              "is_empty",
              "is_not_empty"
            ],
            "description": "Comparison operator. Use in with an array, or omit value for is_empty and is_not_empty."
          },
          "value": {
            "description": "The comparison value; an array for `in`; omitted for is_empty / is_not_empty."
          }
        },
        "required": [
          "field",
          "op"
        ],
        "additionalProperties": false
      },
      "description": "Conditions the row must ALL satisfy."
    },
    "sort": {
      "type": "object",
      "properties": {
        "field": {
          "type": "string",
          "description": "`data.<field>` for a field of the record, or one of its own id, created_at, updated_at, created_by, private.",
          "enum": [
            "id",
            "created_at",
            "updated_at",
            "created_by",
            "private",
            "data.conversation_ref",
            "data.sender_role",
            "data.sender_ref",
            "data.channel",
            "data.direction",
            "data.body",
            "data.event",
            "data.attachments",
            "data.delivery",
            "data.delivery_reason"
          ]
        },
        "direction": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "description": "Sort direction: asc for ascending or desc for descending."
        }
      },
      "required": [
        "field"
      ],
      "additionalProperties": false,
      "description": "Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "default": 100,
      "description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
    },
    "cursor": {
      "type": "string",
      "description": "The `next_cursor` of the previous page."
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "limit": 10
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "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](/developers/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](/developers/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,
        "title": "InboxMessageRecord"
      },
      "description": "Records visible under the credential's grants and the selected data scope, matching the requested filters. Pass next_cursor as cursor to continue when a next cursor is returned."
    },
    "next_cursor": {
      "type": "string",
      "description": "Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "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?"
          }
        }
      ]
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.