---
title: "Retrieve queue"
method: GET
path: "/api/v1/queues/{id}"
tags: ["Queue"]
---

# Retrieve queue

`GET /api/v1/queues/{id}`

Get a queue object.

## Path parameters

- `id` integer, required

## Response `200`

OK

- Queue
  - `id` integer, required — ID of the queue.
  - `name` string, required — Name of the queue (max. 255 characters).
  - `url` string, uri, required — URL of the queue.
  - `workspace` string, uri, nullable, required — Workspace in which the queue should be placed (it can be set to `null`, but bare in mind that it will make the queue invisible in the Rossum UI and it may cause some unexpected consequences).
  - `connector` string, uri, nullable, required — Connector associated with the queue.
  - `webhooks` string[], required — (Deprecated) Webhooks associated with the queue (serves as an alias for `hooks` attribute).
  - `hooks` string[], required — Hooks associated with the queue.
  - `schema` string, uri, required — Schema which will be applied to annotations in this queue.
  - `inbox` string, uri, nullable, required — Inbox for import to this queue.
  - `users` string[], required — Users associated with this queue.
  - `session_timeout` string, required — Time before annotation will be returned from `reviewing` status to `to_review` (timeout is evaluated every 10 minutes).
  - `rir_url` string, uri, nullable, required — (Deprecated) Use `generic_engine` or `dedicated_engine` to set AI Core Engine. <Callout type="warn"> Since April 5, 2022, `rir_url` and `agenda` in `rir_params` is no longer used to set AI Engine to the Queue. To change engine use attributes `generic_engine` and `dedicated_engine`. Queues created with parameter `rir_url` will have corresponding `generic_engine` or `dedicated_engine` set automatically. </Callout>
  - `rir_params` string, nullable, required — URL parameters to be passed to the AI Core Engine. More specific AI Core Engine parameters influencing the extraction may be set using this field. Publicly available parameters: - `effective_page_count` (int): Limits the extraction to the first `effective_page_count` pages of the document. Useful to prevent data extraction from additional pages of unrelated, but included documents. Default: 32 (pages to be extracted from a document). - `tables` (boolean): Allows disabling line item data extraction. Useful to speed up data extraction when line item details are not required, especially on long documents with large tables. Default: true (line items are being extracted).
  - `dedicated_engine` string, uri, nullable, required — Dedicated engine used for processing documents uploaded to this queue. If `dedicated_engine` is set `generic_engine` must be `null`. If both engines are `null`, a default generic one gets set.
  - `generic_engine` string, uri, nullable, required — Generic engine used for processing documents uploaded to this queue. If `generic_engine` is set `dedicated_engine` must be `null`. If both engines are `null`, a default generic one gets set.
  - `counts` object, required — Count of annotations per status.
    - `importing` integer
    - `split` integer
    - `failed_import` integer
    - `to_review` integer
    - `reviewing` integer
    - `confirmed` integer
    - `exporting` integer
    - `postponed` integer
    - `failed_export` integer
    - `exported` integer
    - `deleted` integer
    - `purged` integer
    - `rejected` integer
  - `default_score_threshold` number, float, required — Threshold used to automatically validate field content based on AI confidence scores. <Callout type="warn"> The old behavior enabled `default_score_threshold` set to null on queue. When threshold on queue was set to null then default value 0.975 was used. Starting from February 24, 2020 setting of default_score_threshold to null is deprecated. Due to backward compatibility if null value is passed then default value 0.8 is set to `default_score_threshold`. </Callout>
  - `automation_enabled` boolean, required — Toggle for switching automation on/off.
  - `automation_level` 'never' | 'confident' | 'always', required — Set level of automation. `always` - Auto-export all documents with no validation errors. When there is an error triggered for a non-required field, such values are deleted and export is re-tried. `confident` - Auto-export documents with at least one validation source and no validation errors. `never` - Annotation is not automatically exported and must be validated in UI manually.
  - `locale` string, required — Typical originating region of documents processed in this queue specified in the locale format. If `auto` option is chosen, the locale will be detected automatically if the organization group has access to Aurora engine. Otherwise, default option (`en_GB`) will be used. The `locale` field is a hint for the AI Engine on how to resolve some ambiguous cases during data extraction, concerning e.g. date formats or decimal separators that may depend on the locale. For example, in US the typical date format is mm/dd/yyyy whilst in Europe it is dd.mm.yyyy. A date such as "12. 6. 2018" will be extracted as Jun 12 when locale is `en_GB`, while the same date will be extracted as Dec 6 when locale is `en_US`.
  - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
  - `use_confirmed_state` boolean, required — Affects exporting - when `true`, confirm endpoint transitions annotation to `confirmed` status instead to `exporting`.
  - `document_lifetime` string, nullable, required — Data retention period -- annotations will be automatically purged this time after their creation. The format of the value is '[DD] [HH:[MM:]]ss[.uuuuuu]', e.g. 90 days retention can be set as '90 00:00:00'. Please keep in mind that purging documents in Rossum can limit its learning capabilities. This is a priced feature and has no effect unless enabled.
  - `status` 'active' | 'deletion_requested' | 'deletion_in_progress' | 'deletion_failed', required — Current status of the queue. `active` - This is the default status. Queue is usable. `deletion_requested` - Queue is marked for deletion (by calling `DELETE /v1/queues/<id>`). Will be asynchronously deleted after `delete_after`. `deletion_in_progress` - Queue is currently being deleted. When a queue has this status some raise conditions may occur as the related objects are being gradually deleted. `deletion_failed` - Something wrong happened in the process of queue deletion. The queue may be in an inconsistent state. Please note, that document import (via upload as well as email) is disabled while the queue status is one of `deletion_requested`, `deletion_in_progress`, `deletion_failed`.
  - `modified_by` string, uri, nullable, required — User that last modified the object.
  - `modified_at` string, date-time, nullable, required — Timestamp of last modification.
  - `settings` object, required — Queue UI settings.
    - `columns` object[] — (Deprecated, use `annotation_list_table` instead) List that contains schema ids to be shown on a dashboard.
    - `hide_export_button` boolean — Toggle to uncover "Export" button on dashboard (useful when `queue.use_confirmed_state = true`), which allows manual export of annotations in `confirmed` status.
    - `autopilot` object, nullable — Autopilot configuration describing which fields can be confirmed automatically.
    - `accepted_mime_types` string[] — List of MIME types which can be uploaded to the queue. This can contain wildcards such as `image/*` or exact type like `application/pdf`.
    - `automation` object — Queue automation settings.
      - `automate_duplicates` boolean — When set to `true`, automation will be enabled for documents that have a duplicates. Disabled if parameter is `false`.
      - `automate_suggested_edit` boolean — When set to `true`, automation will be enabled for annotations containing suggested edits. Disabled if parameter is `false`.
    - `rejection_config` object — Queue rejection settings.
      - `enabled` boolean — Dashboard `Rejected` is visible in application when enabled is set to `true`.
    - `suggested_recipients_sources` object[] — Queue suggested email recipients settings.
      - `source` 'email_header' | 'extracted_value' | 'vendor_database' | 'queue_mailing_history' | 'organization_users' — Indicates source of the suggested recipients email address. `email_header` - Email is taken from the sender in header of the email. `extracted_value` - Email is extracted from annotation data - schema_id is used to find requested value. `vendor_database` - Email is extracted from annotation data - schema_id is used to find requested value. Value is filled by vendor matching connector. `queue_mailing_history` - Emails are taken from all the recipient inside all the emails send inside the email's queue. `organization_users` - Emails are taken from the users of related organization.
      - `schema_id` string — Used for finding appropriate datapoint value in annotation data (necessary only for vendor_database and extracted_value sources).
    - `suggested_edit` 'suggest' | 'disable' — Allow to split document (semi-)automatically. Allowed values are `suggest` and `disable`.
    - `dashboard_customization` object — Dashboard customization settings.
      - `all_documents` boolean — When set to `true`, all UI tabs are merged into one, so the documents with different statuses are mixes in one tab instead of having its own one.
      - `confirmed` boolean — When set to `true`, UI tab for `confirmed` documents will be shown. Relates to the queue settings attribute `use_confirmed_state` is set to true.
      - `deleted` boolean — When set to `true`, UI tab for documents in `deleted` state will be shown.
      - `exported` boolean — When set to `true`, UI tab for documents in `exported` state will be shown.
      - `postponed` boolean — When set to `true`, UI tab for documents in `postponed` state will be shown.
      - `rejected` boolean — When set to `true`, UI tab for documents in `rejected` state will be shown.
      - `to_review` boolean — When set to `true`, UI tab for documents in `to_review` state will be shown.
    - `email_notifications` object — Queue email notifications settings.
      - `recipient` object, nullable — Information about email address to send notifications to (e.g. about failed import). It contains keys `email` and `name`.
        - `email` string, email
        - `name` string
      - `unprocessable_attachments` boolean — Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply.
      - `email_with_no_attachments` boolean — Whether to send notification when no processable documents were found.
      - `postponed_annotations` boolean — Whether to send notification when annotation is postponed.
      - `deleted_annotations` boolean — Whether to send notification when annotation is deleted.
    - `workflows` object — Queue workflows settings. Talk to your Rossum representative to enable [workflows](tag#Workflows) for your queue.
      - `enabled` boolean — Dashboard `Workflows` is visible in application when enabled is set to `true`. Also enables the workflow automation.
      - `bypass_workflows_allowed` boolean — Whether to allow to confirm annotation with option `skip_workflows=true`.
    - `annotation_list_table` object — Configuration of annotation dashboard columns.
      - `columns` AnnotationListTable[] — Configuration of columns on annotation dashboard.
        - `visible` boolean — Column is visible on the dashboard.
        - `width` number, float — Width of the column.
        - `column_type` 'meta' | 'schema' — Type of the field (`meta` - annotation meta field, `schema` - annotation content field).
        - `schema_id` string — `schema_id` of the extracted field (only for `column_type=schema`).
        - `data_type` 'date' | 'number' | 'string' | 'boolean' — Data type of the extracted field (only for `column_type=schema`). Allowed values are `date`, `number`, `string`, `boolean`.
        - `meta_type` string — Meta column type (only for `column_type=meta`). Allowed values can be found in `meta_field` table (+ additionally `details`).
    - `upload_values` object[] — Configuration of values to be specified during upload.
      - `id` string — ID of the value.
      - `type` 'values' | 'metadata' — Type of the value - `values` or `metadata` — specify how to pass the value.
      - `data_type` 'enum' | 'string' — Data type of the value - `enum` or `string`.
      - `label` string — Label to be used in UI.
      - `enum_options` object[], nullable — List of objects with `value` and `label` fields. Only allowed for `enum` type.
        - `value` string
        - `label` string
      - `required` boolean — Whether the value is required to be set during upload.
    - `html_conversion_enabled` boolean — When set to `true`, documents with MIME type `text/html` uploaded to the queue are automatically converted to PDF. Set to `false` to disable automatic conversion.
    - `txt_conversion_enabled` boolean — When set to `true`, `.txt` documents with MIME type `text/plain` uploaded to the queue are automatically converted to PDF. Set to `false` to disable automatic conversion.
    - `ui_upload_enabled` boolean — Flag for enabling upload for particular queue in Rossum UI.
    - `ui_on_edit_confirm` 'annotation_list' | 'edit_next' | 'validate_first' — Changes edit screen confirm button behavior. Allowed values are `annotation_list`, `edit_next`, `validate_first`.
    - `ui_validation_screen_enabled` boolean — Flag for enabling validation screen for a particular queue in Rossum UI. If disabled, opening of a document will trigger a redirect to an edit screen.
    - `ui_edit_target_queue_selection_enabled` boolean — Flag for enabling target queue selection on the edit screen in Rossum UI. If disabled, the target queue selector is hidden.
    - `ui_edit_always_split_document` boolean — Flag for whether the edit screen always splits the document into the selected pages in Rossum UI.
    - `ui_edit_values` object[] — Configuration of values to be specified during edit_pages.
      - `id` string — ID of the value.
      - `label` string — Label to be used in UI.
      - `data_type` 'enum' | 'string' — Type of the value - `enum` or `string`.
      - `enum_options` object[], nullable — List of objects with `value` and `label` fields. Only allowed for `enum` data_type.
        - `value` string
        - `label` string
      - `required` boolean — Whether the value is required to be set during edit.
  - `workflows` object[], required — Workflows set for the queue.
    - `url` string, uri — Url of the workflow object.
    - `priority` integer — Priority of the linked workflow. Designate the order of their evaluation (lower number means it's evaluated sooner).

## 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)