---
title: "List Flow Control Keys"
method: GET
path: "/v2/flowControl"
tags: ["Flow Control"]
---

# List Flow Control Keys

`GET /v2/flowControl`

## Request

- Base URL: `https://qstash-eu-central-1.upstash.io`
- URL: `https://qstash-eu-central-1.upstash.io/v2/flowControl`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `qstash_token`
- TypeScript: <https://skmtc.dev/upstash/apis/qstash-rest-api/docs/v2/flowControl/get.ts> (a function with typed inputs; its response is checked against the schema)

List all Flow Control keys

## Response `200`

Flow control keys retrieved successfully

- FlowControlKey[]
  - `flowControlKey` string: The flow control key name
  - `waitListSize` integer: The number of messages waiting due to flow control configuration.
  - `parallelismMax` integer: The configured maximum number of messages allowed to run concurrently, if parallelism is set.
  - `parallelismCount` integer: The current number of messages running in parallel.
  - `rateMax` integer: The configured maximum number of messages allowed per rate period, if rate limiting is set.
  - `rateCount` integer: The number of messages dispatched in the current rate period.
  - `ratePeriod` integer: The length of the rate period in seconds.
  - `ratePeriodStart` integer: Unix timestamp (seconds) when the current rate period started.
  - `isPinnedParallelism` boolean: True if the flow-control key has a pinned parallelism configuration.
  - `isPinnedRate` boolean: True if the flow-control key has a pinned rate configuration.
  - `isPaused` boolean: True if the delivery of messages associated with the flow-control key is paused.

## Changes

- **2026-03-16** `2a63f4cd1ddc`: 3 info
  - added the optional property `items/isPaused` to the response with the `200` status
  - added the optional property `items/isPinnedParallelism` to the response with the `200` status
  - added the optional property `items/isPinnedRate` to the response with the `200` status
- **2026-02-25** `4e5fc079d9b0`: 1 breaking, 2 warning
  - the response's body type changed from `object` to `array` for status `200`
  - removed the optional property `flowControlKey` from the response with the `200` status
  - removed the optional property `waitlistSize` from the response with the `200` status

[Operation history](https://skmtc.dev/upstash/apis/qstash-rest-api/changes/v2/flowControl/get.md)

---

[API](https://skmtc.dev/upstash/apis/qstash-rest-api.md) - [All operations](https://skmtc.dev/upstash/apis/qstash-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upstash/apis/qstash-rest-api/revisions/0c3b83ef4770?raw)