# List inbox messages

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

POST https://api.brigg.app/v1/operations/support.ListInboxMessages

## 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](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filters` | array of [object](#request-filters) | No | Conditions the row must ALL satisfy. |
| `sort` | [object](#request-sort) | No | Sort order for the results. Defaults to updated_at descending, with id as a tie-breaker. |
| `limit` | integer | No | Maximum number of results to return in this page. Continue with next_cursor when returned. Default: `100`. Minimum: 1. |
| `cursor` | string | No | The `next_cursor` of the previous page. |

### request.filters[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `field` | string | Yes | `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"`. |
| `op` | string | Yes | 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"`. |
| `value` | JSON value | No | The comparison value; an array for `in`; omitted for is_empty / is_not_empty. |

### request.sort

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `field` | string | Yes | `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"`. |
| `direction` | string | No | Sort direction: asc for ascending or desc for descending. Allowed: `"asc"`, `"desc"`. |

## 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.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [InboxMessageRecord](#inboxmessagerecord-response-items) | Yes | 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` | string | No | Pass this value as cursor to continue with the same filters, sort and credential. Omitted when there are no more results. |

### InboxMessageRecord · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | 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` | number | Yes | Time the record was created, in Unix milliseconds. |
| `updated_at` | number | Yes | Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads. |
| `created_by` | string or null | Yes | 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` | boolean | Yes | 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` | [InboxMessage](#inboxmessage-response-items-data) | Yes | The record's fields. |

### InboxMessage · response.items[].data

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `conversation_ref` | string | Yes | ID of a `core:Conversation` record. Find it with [support.ListConversations](https://developer.brigg.app/reference/support/ListConversations) and use the top-level `id`. This is not an account ID or a display name. |
| `sender_role` | string | Yes | Who produced the message: customer contact, automated agent, workspace member or system. Allowed: `"contact"`, `"agent"`, `"member"`, `"system"`. |
| `sender_ref` | string | No | ID of a `core:Person` record. Find it with [customers.ListPeople](https://developer.brigg.app/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name. |
| `channel` | string | No | Channel carrying the message. Internal notes use internal and are not customer replies. Allowed: `"email"`, `"web_chat"`, `"contact_form"`, `"sms"`, `"phone"`, `"internal"`. |
| `direction` | string | No | Inbound from a customer, outbound to a customer, or internal to the support team. Allowed: `"inbound"`, `"outbound"`, `"internal"`. |
| `body` | string | No | Message content as stored for its channel. |
| `event` | string | No | System event associated with the message, when present. |
| `attachments` | array of [object](#response-items-data-attachments) | No | Attachments with a file ID, original filename and size in bytes. |
| `delivery` | string | No | Recorded delivery state: queued, sent, delivered or failed. Sent does not guarantee receipt. Allowed: `"queued"`, `"sent"`, `"delivered"`, `"failed"`. |
| `delivery_reason` | string | No | 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"`. |

### response.items[].data.attachments[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `file_id` | string | No | File identifier. |
| `filename` | string | No | Original filename, including its extension. |
| `size` | number | No | File size in bytes. |

## 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](https://developer.brigg.app/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.

```typescript
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](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| 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

- [Get inbox message](https://developer.brigg.app/reference/support/GetInboxMessage)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### First page

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


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

#### TypeScript


```typescript
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({
    "limit": 10
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "limit": 10
}
request = Request(
    "https://api.brigg.app/v1/operations/support.ListInboxMessages",
    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
```

#### Response example


```json
{
  "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?"
      }
    }
  ]
}
```

### Messages in a conversation

Read a case's messages chronologically. Internal notes and customer-facing replies remain distinguishable by channel and direction.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/support.ListInboxMessages' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "limit": 50,
  "filters": [
    {
      "field": "data.conversation_ref",
      "op": "eq",
      "value": "e_conversation_onboarding"
    }
  ],
  "sort": {
    "field": "created_at",
    "direction": "asc"
  }
}'
```

#### TypeScript


```typescript
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({
    "limit": 50,
    "filters": [
      {
        "field": "data.conversation_ref",
        "op": "eq",
        "value": "e_conversation_onboarding"
      }
    ],
    "sort": {
      "field": "created_at",
      "direction": "asc"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "limit": 50,
  "filters": [
    {
      "field": "data.conversation_ref",
      "op": "eq",
      "value": "e_conversation_onboarding"
    }
  ],
  "sort": {
    "field": "created_at",
    "direction": "asc"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.ListInboxMessages",
    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
```

#### Response example


```json
{
  "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?"
      }
    }
  ]
}
```

### Records updated since a checkpoint

6 October 2026 at 00:00 UTC. Use an overlap window and upsert by ID when synchronizing.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/support.ListInboxMessages' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}'
```

#### TypeScript


```typescript
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({
    "filters": [
      {
        "field": "updated_at",
        "op": "gte",
        "value": 1791244800000
      }
    ],
    "sort": {
      "field": "updated_at",
      "direction": "asc"
    },
    "limit": 100
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "filters": [
    {
      "field": "updated_at",
      "op": "gte",
      "value": 1791244800000
    }
  ],
  "sort": {
    "field": "updated_at",
    "direction": "asc"
  },
  "limit": 100
}
request = Request(
    "https://api.brigg.app/v1/operations/support.ListInboxMessages",
    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
```

#### Response example


```json
{
  "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?"
      }
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "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
    }
  ]
}
```


```json-schema-response
{
  "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](https://developer.brigg.app/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](https://developer.brigg.app/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?"
          }
        }
      ]
    }
  ]
}
```