Queue
List queues
Retrieve all queue objects.
get/api/v1/queues
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).
ordering'id' | '-id' | 'name' | '-name' | 'workspace' | '-workspace' | 'connector' | '-connector' | 'webhooks' | '-webhooks' | 'schema' | '-schema' | 'inbox' | '-inbox' | 'locale' | '-locale'
Result ordering. Supported ordering - id, name, workspace, connector, webhooks, schema, inbox, locale.
Response
OK
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
}
]
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.