List QStash Users

Retrieves a list of all QStash users associated with the account, including plan details, limits, and configuration.

1 min read

get/qstash/users

Request example

curl --request GET \
  --url https://api.upstash.com/v2/qstash/users \
  --header 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Response

[
  {
    "customer_id": "example@upstash.com",
    "id": "99a4c327-31f0-490f-a594-043ade84085a",
    "token": "ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==",
    "read_only_token": "ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==",
    "active": true,
    "state": "active",
    "modifying_state": "suspended",
    "last_plan_upgrade_time": 0,
    "max_message_size": 1048576,
    "max_requests_per_day": 1000,
    "max_requests_per_day_hard": 1000,
    "max_endpoints_per_topic": 100,
    "max_requests_per_second": 100,
    "max_dlq_size": 1000000,
    "max_retries": 999,
    "max_topics": 1,
    "max_schedules": 10,
    "max_events_size": 10000,
    "max_dlq_retention_time_milis": 259200000,
    "max_delay": 604800,
    "max_parallelism": 2,
    "max_global_parallelism": 10,
    "max_queues": 10,
    "max_bandwidth_per_second": 1048576,
    "prod_pack_enabled": false,
    "prometheus_enabled": "false",
    "timeout": 900,
    "type": "free",
    "region": "eu-central-1",
    "reserved_type": "",
    "reserved_price": 0,
    "created_by": "cahidarda@upstash.com",
    "creation_time": 1781871358,
    "deletion_time": 0,
    "budget": 0,
    "enterprise": {
      "enabled": true
    }
  }
]

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)

idstring#

Unique identifier for the QStash user account

tokenstring#

Authentication token for QStash operations

read_only_tokenstring#

Read-only authentication token for QStash operations

activeboolean#

Whether the QStash account is active

statestring#

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

modifying_statestring#

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

last_plan_upgrade_timeinteger#

Unix timestamp of the last plan upgrade

max_message_sizeinteger#

Maximum message size in bytes

max_requests_per_dayinteger#

Soft limit for maximum requests per day

max_requests_per_day_hardinteger#

Hard limit for maximum requests per day

max_endpoints_per_topicinteger#

Maximum number of endpoints allowed per topic

max_requests_per_secondinteger#

Maximum requests per second (rate limit)

max_dlq_sizeinteger#

Maximum dead letter queue size

max_retriesinteger#

Maximum number of retry attempts for failed messages

max_topicsinteger#

Maximum number of topics allowed

max_schedulesinteger#

Maximum number of schedules allowed

max_events_sizeinteger#

Maximum size for events

max_dlq_retention_time_milisinteger#

Maximum retention time for dead letter queue in milliseconds

max_delayinteger#

Maximum delay for scheduled messages in seconds

max_parallelisminteger#

Maximum parallel processing per endpoint

max_global_parallelisminteger#

Maximum global parallel processing across all endpoints

max_queuesinteger#

Maximum number of queues allowed

max_bandwidth_per_secondinteger#

Maximum bandwidth per second in bytes

prod_pack_enabledboolean#

Whether production pack features are enabled

prometheus_enabledenum<string>#

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

Options:truefalse

timeoutinteger#

Request timeout in seconds

typeenum<string>#

Account billing plan category

Options:freepaid

regionenum<string>#

Region where the QStash instance is deployed

Options:eu-central-1us-east-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).

reserved_priceinteger#

Reserved plan price (may be 0)

created_bystring#

Email of the user who created this account

creation_timeinteger#

Unix timestamp of account creation

deletion_timeinteger#

Unix timestamp of account deletion (0 if not deleted)

budgetinteger#

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

enterpriseobject#

Present for enterprise accounts

Show child attributes

enabledboolean#

Whether enterprise features are enabled

Delete Search Index Get QStash