Skip to main content
GET
List volunteers

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

stage
enum<string>
Available options:
waiting,
ready,
active
q
string

The name contains this text.

limit
integer
default:25

How many to return. 25 unless you say, 100 at most.

Required range: 1 <= x <= 100
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of volunteers.

results
object[]
required
total
integer
required

How many match the stage and the search.

limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

stages
object[]
required

Each stage with its label and how many are in it.