Skip to main content
get/qstash/users
Request example
Response
get/qstash/users

Authorization

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

Responses

application/json
200
Successful response
customer_idstring#
Customer identifier (email or team ID)

Example:"example@upstash.com"

idstring#
Unique identifier for the QStash user account

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

tokenstring#
Authentication token for QStash operations

Example:"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

read_only_tokenstring#
Read-only authentication token for QStash operations

Example:"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

activeboolean#
Whether the QStash account is active

Example:true

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

Example:"active"

modifying_statestring#
Transitional state while the console applies an async change (e.g. suspended during suspension). Omitted when no change is in progress.

Example:"suspended"

last_plan_upgrade_timeinteger#
Unix timestamp of the last plan upgrade

Example:0

max_message_sizeinteger#
Maximum message size in bytes

Example:1048576

max_requests_per_dayinteger#
Soft limit for maximum requests per day

Example:1000

max_requests_per_day_hardinteger#
Hard limit for maximum requests per day

Example:1000

max_endpoints_per_topicinteger#
Maximum number of endpoints allowed per topic

Example:100

max_requests_per_secondinteger#
Maximum requests per second (rate limit)

Example:100

max_dlq_sizeinteger#
Maximum dead letter queue size

Example:1000000

max_retriesinteger#
Maximum number of retry attempts for failed messages

Example:999

max_topicsinteger#
Maximum number of topics allowed

Example:1

max_schedulesinteger#
Maximum number of schedules allowed

Example:10

max_events_sizeinteger#
Maximum size for events

Example:10000

max_dlq_retention_time_milisinteger#
Maximum retention time for dead letter queue in milliseconds

Example:259200000

max_delayinteger#
Maximum delay for scheduled messages in seconds

Example:604800

max_parallelisminteger#
Maximum parallel processing per endpoint

Example:2

max_global_parallelisminteger#
Maximum global parallel processing across all endpoints

Example:10

max_queuesinteger#
Maximum number of queues allowed

Example:10

max_bandwidth_per_secondinteger#
Maximum bandwidth per second in bytes

Example:1048576

prod_pack_enabledboolean#
Whether production pack features are enabled

Example:false

prometheus_enabledenum<string>#
Whether Prometheus metrics export is enabled ("true" / "false" string as returned by the API)
Options:truefalse

Example:"false"

timeoutinteger#
Request timeout in seconds

Example:900

typeenum<string>#
Account billing plan category
Options:freepaid

Example:"free"

regionenum<string>#
Region where the QStash instance is deployed
Options:eu-central-1us-east-1

Example:"eu-central-1"

reserved_typestring#

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:""

reserved_priceinteger#
Reserved plan price (may be 0)

Example:0

created_bystring#
Email of the user who created this account

Example:"cahidarda@upstash.com"

creation_timeinteger#
Unix timestamp of account creation

Example:1781871358

deletion_timeinteger#
Unix timestamp of account deletion (0 if not deleted)

Example:0

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

Example:0

enterpriseobject#
Present for enterprise accounts