TRtriggerdotdev
queues

Retrieve a queue

Changed on

Get a queue by its ID, or by type and name.

get/api/v1/queues/{queueParam}

Request

Path parameters

queueParamstring required

The queue ID (e.g., queue_1234), or the name of the queue when using the type query parameter.

Query parameters

type'id' | 'task' | 'custom'

How to interpret the queueParam path parameter:

  • id: Treat as a queue ID (default)
  • task: Treat as a task ID to get the task's default queue
  • custom: Treat as a custom queue name

Response

Successful request

idstring required

The queue ID, e.g., queue_1234

namestring required

The queue name. For task queues, this is the task ID. For custom queues, this is the name you specified.

type'task' | 'custom' required

The type of queue:

  • task: Created automatically for each task
  • custom: Created explicitly in your code using queue()
version'V1' | 'V2' required

Discriminates the shape:

  • V1: the queue carries its own concurrencyLimit (applied per key when runs pass a concurrencyKey, to the whole queue when they don't) and its concurrency override state
  • V2: the queue is only the line runs wait in; concurrency is declared with the task concurrency option and managed through the concurrency-limits endpoints. concurrencyLimit is always null and concurrency is absent.
runninginteger required

The number of runs currently executing

queuedinteger required

The number of runs currently queued

pausedboolean required

Whether the queue is paused. When paused, no new runs will start.

concurrencyLimitinteger nullable

The queue's own concurrency limit. Meaningful on V1 queues; always null on V2 queues.

Example response

{
  "id": "queue_1234",
  "name": "my-task-id",
  "type": "task",
  "version": "V1",
  "running": 5,
  "queued": 10,
  "concurrencyLimit": 10,
  "concurrency": {
    "current": 10,
    "base": 10
  }
}

Changes