---
title: "List inboxes"
method: GET
path: "/api/v1/inboxes"
tags: ["Inbox"]
---

# List inboxes

`GET /api/v1/inboxes`

Retrieve all inbox objects.

## Query parameters

- `page_size` integer
- `cursor` string
- `id` integer[]
- `name` string
- `email` string
- `email_prefix` string
- `bounce_email_to` string
- `bounce_unprocessable_attachments` boolean
- `bounce_postponed_annotations` boolean
- `bounce_deleted_annotations` boolean
- `bounce_email_with_no_attachments` boolean
- `ordering` 'id' | '-id' | 'name' | '-name' | 'email' | '-email' | 'email_prefix' | '-email_prefix' | 'bounce_email_to' | '-bounce_email_to'

## Response `200`

OK

- object
  - `results` Inbox[]
    - `id` integer, required — ID of the inbox.
    - `name` string, required — Name of the inbox (not visible in UI).
    - `url` string, url, required — URL of the inbox.
    - `queues` string[], required — Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.
    - `email` string, email, required — Rossum email address (e.g. `east-west-trading-co-a34f3a@example.rossum.app`).
    - `email_prefix` string, required — Rossum email address prefix (e.g. `east-west-trading-co`). Maximum length allowed is 57 chars.
    - `bounce_email_to` string, email, nullable, required — (Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.
    - `bounce_unprocessable_attachments` boolean, required — (Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.
    - `bounce_postponed_annotations` boolean, required — (Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.
    - `bounce_deleted_annotations` boolean, required — (Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.
    - `bounce_email_with_no_attachments` boolean, required — (Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.
    - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
    - `filters` Filters, required — Filtering of incoming emails and documents. `allowed_senders` and `denied_senders` settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards: - `*` matches everything (e.g. `*@rossum.ai` matches every email from `rossum.ai` domain) - `?` matches any single character (e.g. `john?doe@rossum.ai` matches `john.doe@rossum.ai` as well as `john-doe@rossum.ai`) `document_rejection_conditions` defines rules for filtering incoming documents via email.
      - `allowed_senders` string[] — Only emails with matching sender's address will be processed. If empty all senders all allowed.
      - `denied_senders` string[] — Incoming emails from email address matching one of these will be ignored.
      - `document_rejection_conditions` DocumentRejectionConditions — Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions. Setting attribute value to null (or empty list in case of `mime_types`, `file_name_regexes`) will turn that specific filtering feature off.
        - `enabled` boolean — Whether the document rejection feature is enabled.
        - `resolution_lower_than_px` integer[] — Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.
        - `file_size_less_than_b` integer, nullable — Size of document in bytes. A file with smaller size will be filtered out.
        - `mime_types` string[] — List of mime types to filter out (must match `^.+/.+$`).
        - `file_name_regexes` string[], nullable — Regular expressions in `re2` format (for more info about syntax see [docs](https://github.com/google/re2/wiki/Syntax)). A file with matching name will be filtered out.
    - `dmarc_check_action` 'accept' | 'drop', required — Decides what to do with incoming emails, that don't pass the DMARC check.
    - `modified_by` string, uri, nullable, required — User that last modified the object.
    - `modified_at` string, date-time, nullable, required — Timestamp of last modification.
  - `pagination` Pagination
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)