Skip to main content
GET
Consume events for a consumer group

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

group
string
required

Consumer-group name (1–128 chars of letters, digits, ._:-, starting alphanumeric). Offsets are tracked per group, so independent consumers use distinct groups.

limit
integer

Maximum events to return (1–500, default 100).

Response

The next ordered batch of events for the group.

The next ordered batch of events for the group.

data
object[]
meta
object