Admin — list voucher batches in a campaign

ADMIN

Lists a campaign's batches, newest first. This is how a drop is found
again: batch_id is otherwise only ever returned in the 202 that
created the batch, and it is what withdrawing a batch requires.

campaign_id is required — the index is keyed by campaign.

Passing tag resolves the single batch holding that tag, which is the
handle an operator is likely to have. Tags are unique per campaign, so
the result is at most one batch; a withdrawal reuses its target's tag, so
a tag that has been withdrawn returns the original batch, not the
deletion. Batches created before tagging existed are not reachable this
way and neither are vouchers imported through the CLI without -tag,
which have no batch record at all.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required

Campaign to list. Callers whose credentials are bound to a single campaign may only pass their own.

string

Return only the batch that holds this tag. Matched exactly after the same trimming and uppercasing applied when the batch was created.

string
enum

Restrict to batches of one kind.

Allowed:
string
enum

Restrict to batches in one state.

Allowed:
integer
1 to 100
Defaults to 20

Number of items to return per page.

string

Opaque pagination cursor returned by a previous response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json