Skip to main content
GET
List QStash Users

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

Successful response

customer_id
string

Customer identifier (email or team ID)

Example:

"example@upstash.com"

id
string<uuid>

Unique identifier for the QStash user account

Example:

"99a4c327-31f0-490f-a594-043ade84085a"

password
string

QStash authentication password

Example:

"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

token
string

Authentication token for QStash operations

Example:

"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

active
boolean

Whether the QStash account is active

Example:

true

state
string

Current state of the QStash account (e.g. active, passive; other values may be returned)

Example:

"active"

modifying_state
string

Transitional state while the console applies an async change (e.g. suspended during suspension)

Example:

"suspended"

last_plan_upgrade_time
integer<int64>

Unix timestamp of the last plan upgrade

Example:

1761267303

max_message_size
integer

Maximum message size in bytes

Example:

52428800

max_requests_per_day
integer

Soft limit for maximum requests per day

Example:

1000000

max_requests_per_day_hard
integer

Hard limit for maximum requests per day

Example:

10000000

max_endpoints_per_topic
integer

Maximum number of endpoints allowed per topic

Example:

1000

max_requests_per_second
integer

Maximum requests per second (rate limit)

Example:

500

max_dlq_size
integer

Maximum dead letter queue size

Example:

2147483647

max_completion_tokens_per_day
integer

Daily limit for completion tokens (LLM-related usage)

Example:

10000

max_completion_tokens_per_minute
integer

Per-minute limit for completion tokens

Example:

1000

max_completions_per_day
integer

Daily cap on completion requests

Example:

100

max_completions_per_minute
integer

Per-minute cap on completion requests

Example:

10

max_retries
integer

Maximum number of retry attempts for failed messages

Example:

20

max_topics
integer

Maximum number of topics allowed

Example:

1000

max_schedules
integer

Maximum number of schedules allowed

Example:

1000000

max_events_size
integer

Maximum size for events

Example:

100000

max_dlq_retention_time_milis
integer<int64>

Maximum retention time for dead letter queue in milliseconds

Example:

2592000000

max_delay
integer

Maximum delay for scheduled messages in seconds

Example:

2147483647

max_parallelism
integer

Maximum parallel processing per endpoint

Example:

10

max_global_parallelism
integer

Maximum global parallel processing across all endpoints

Example:

200

max_queues
integer

Maximum number of queues allowed

Example:

1000

retention
integer

Message retention period (see product defaults for unit/context)

Example:

7

timeout
integer

Request timeout in seconds

Example:

21600

rate_limit
integer

Account-level rate limit configuration value exposed by the API

Example:

100

type
enum<string>

Account billing plan category

Available options:
free,
paid
Example:

"paid"

reserved_type
string

Fixed-tier or enterprise label when applicable. May be empty/absent for non-fixed plans. Known values include qstash_fixed_1m, qstash_fixed_10m, qstash_fixed_100m, qstash_fixed. Enterprise accounts may use the prefix enterprise: followed by an identifier (e.g. enterprise:acme).

Example:

"qstash_fixed_1m"

reserved_price
number<float>

Reserved plan price (may be 0)

Example:

180

prod_pack_enabled
boolean

Whether production pack features are enabled

Example:

false

prometheus_enabled
enum<string>

Whether Prometheus metrics export is enabled ("true" / "false" string as returned by the API)

Available options:
true,
false
Example:

"false"

enterprise
object

Present for enterprise accounts

region
enum<string>

Region where the QStash instance is deployed

Available options:
eu-central-1,
us-east-1
Example:

"us-east-1"

budget
integer

Monthly spending budget limit in dollars. 0 means no limit.

Example:

0

created_by
string

Email of the user who created this account

Example:

"example@upstash.com"

creation_time
integer<int64>

Unix timestamp of account creation

Example:

1760423113