Gets information about all volunteers for a race.
Please note that this API returns results in pages.
The page
, num
, and sort
parameters can be used to control paging.
You should consider using modified_since_timestamp
to download volunteers since the last API request when you download volunteers over time.
Note that the maximum number of volunteers that can be downloaded at a time is 500.
When using modified_since_timestamp
, note that it returns volunteers that have been modified on or after the specified timestamp.
If modified_since_timestamp
is used in conjunction with the highest returned modified timestamp for subsequent API calls, you may need to increment modified_since_timestamp
to prevent the same volunteer(s) from being returned each time.
{ "volunteers": [ { "assignment_id": 71, "user_id": 2993830, "race_user_id": 879781, "volunteer_task_id": 1286, "assignment_ts": 1639420178, "volunteer_people_resource_id": 1307, "first_name": "Diana", "last_name": "Barnes", "email": "diana.barnes@example.com", "phone": "856-601-1496", "volunteer_session_id": 37, "last_modified_ts": 1639420178, "checked_in": "F", "question_responses": [ { "question_id": 18, "response_id": null, "response": "This is a sample response." }, { "question_id": 19, "response_id": 10, "response": "This is a sample response." } ] }, { "assignment_id": 76, "user_id": 2993835, "race_user_id": 879786, "volunteer_task_id": 1287, "assignment_ts": 1639420198, "volunteer_people_resource_id": 1308, "first_name": "Joe", "last_name": "Mcdonald", "email": "joe.mcdonald@example.com", "phone": "856-524-8059", "volunteer_session_id": 37, "last_modified_ts": 1639420198, "checked_in": "F", "question_responses": [ { "question_id": 18, "response_id": 9, "response": "This is a sample response." }, { "question_id": 19, "response_id": 11, "response": "This is a sample response." } ] } ] }
Parameter | HTTP Method | Default | Description | Datatype |
---|---|---|---|---|
race_id Required |
GET | Race ID. | uint |
|
include_question_responses |
GET | F | Should question responses be included? | bool |
modified_since_timestamp |
GET | Get race volunteers modified since a given time. | uint |
|
api_key |
GET | API key. | string |
|
api_secret |
GET | API secret. | string |
|
num |
GET | 100 | Number of results per page. | uint |
page |
GET | 1 | Number of pages. | uint |