ROrossum
Inbox

List inboxes

Changed on

Retrieve all inbox objects.

get/api/v1/inboxes

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

namestring

Object name filter

emailstring

Email filter

email_prefixstring

Email prefix filter

bounce_email_tostring

Bounce email to filter

bounce_unprocessable_attachmentsboolean

Bounce unprocessable attachments filter

bounce_postponed_annotationsboolean

Bounce postponed annotations filter

bounce_deleted_annotationsboolean

Bounce deleted annotations filter

bounce_email_with_no_attachmentsboolean

Bounce emails with no attachment extracted.

ordering'id' | '-id' | 'name' | '-name' | 'email' | '-email' | 'email_prefix' | '-email_prefix' | 'bounce_email_to' | '-bounce_email_to'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1234,
      "name": "Receipts",
      "url": "https://example.rossum.app/api/v1/inboxes/1234",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199"
      ],
      "email": "east-west-trading-co-a34f3a@example.rossum.app",
      "email_prefix": "east-west-trading-co",
      "bounce_email_to": "bounces@east-west.com",
      "bounce_email_with_no_attachments": true,
      "metadata": {
        "some_key": "some_value"
      },
      "filters": {
        "allowed_senders": [
          "*@rossum.ai",
          "john.doe@company.com",
          "john.doe@company.??"
        ],
        "denied_senders": [
          "spam@*"
        ],
        "document_rejection_conditions": {
          "enabled": true,
          "resolution_lower_than_px": [
            1200,
            600
          ],
          "mime_types": [
            "image/gif"
          ]
        }
      },
      "dmarc_check_action": "accept",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status