Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential2

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Queue

List queues

Changed on Oct 27, 2026

Retrieve all queue objects.

get/api/v1/queues

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/queues/get.ts
A function with typed inputs. Its response is checked against the schema.

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

workspaceinteger

ID of a workspace.

inboxinteger

ID of an inbox.

connectorinteger

ID of a connector.

webhooksstring

IDs of hooks.

hooksstring

IDs of hooks.

localestring

Queue object locale.

dedicated_engineinteger

ID of a dedicated engine.

generic_engineinteger

ID of a generic engine.

deletingboolean

Bool filter - queue is being deleted (delete_after is set).

automation_level'always' | 'confident' | 'never'

Filter by automation level. Supports comma-separated values (e.g. always,confident).

Result ordering. Supported ordering - id, name, workspace, connector, webhooks, schema, inbox, locale.

Response

Example response

{
  "results": [
    {
      "id": 8198,
      "name": "Received invoices",
      "url": "https://example.rossum.app/api/v1/queues/8198",
      "workspace": "https://example.rossum.app/api/v1/workspaces/7540",
      "webhooks": [],
      "hooks": [],
      "schema": "https://example.rossum.app/api/v1/schemas/31336",
      "inbox": "https://example.rossum.app/api/v1/inboxes/1229",
      "users": [
        "https://example.rossum.app/api/v1/users/10775"
      ],
      "session_timeout": "01:00:00",
      "generic_engine": "https://example.rossum.app/api/v1/generic_engines/3000",
      "counts": {
        "to_review": 2
      },
      "default_score_threshold": 0.8,
      "automation_level": "never",
      "locale": "en_US",
      "metadata": {
        "some_key": "some_value"
      },
      "document_lifetime": "01:00:00",
      "status": "active",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z",
      "settings": {
        "hide_export_button": true,
        "accepted_mime_types": [],
        "automation": {
          "automate_duplicates": true
        },
        "rejection_config": {
          "enabled": true
        },
        "suggested_recipients_sources": [
          {
            "source": "email_header"
          }
        ],
        "suggested_edit": "disable",
        "dashboard_customization": {
          "confirmed": true,
          "deleted": true,
          "exported": true,
          "postponed": true,
          "rejected": true,
          "to_review": true
        },
        "email_notifications": {
          "recipient": {
            "email": "john.doe@company.com",
            "name": "John Doe"
          },
          "email_with_no_attachments": true
        },
        "html_conversion_enabled": true,
        "txt_conversion_enabled": true,
        "ui_upload_enabled": true,
        "ui_on_edit_confirm": "validate_first",
        "ui_validation_screen_enabled": true,
        "ui_edit_target_queue_selection_enabled": true,
        "ui_edit_always_split_document": true
      },
      "workflows": [
        {
          "url": "https://example.rossum.app/api/v1/workflows/7540",
          "priority": 2
        }
      ],
      "enabled": true
    }
  ]
}

Changes

Oct 27, 2026e0500ebc86cb Revision changes
- info
  added the optional property /// to the response with the status
Sep 1, 2026f1b5a910991d Revision 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
- 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

Operation history