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_idRequired |
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 |
{
"openapi": "3.0.3",
"info": {
"title": "Get Race Volunteers",
"description": "Get all volunteers for a race.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Volunteers",
"description": "APIs related to Volunteers"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
}
}
},
"paths": {
"/v2/volunteers/get-race-volunteers.json": {
"get": {
"tags": [
"Volunteers"
],
"summary": "Get Race Volunteers",
"description": "Get all volunteers for a race.",
"operationId": "v2_volunteers_get_race_volunteers_json",
"parameters": [
{
"name": "race_id",
"in": "query",
"description": "Race ID.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "include_question_responses",
"in": "query",
"description": "Should question responses be included?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "modified_since_timestamp",
"in": "query",
"description": "Get race volunteers modified since a given time.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "checkin_api_key",
"in": "query",
"description": "Checkin API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-CHECKIN-API-SECRET",
"in": "header",
"description": "Checkin API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_key",
"in": "query",
"description": "API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "api_secret",
"in": "query",
"description": "API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "num",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer",
"default": "100"
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages.",
"required": false,
"schema": {
"type": "integer",
"default": "1"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": [
"partners",
"race_directors",
"timers"
]
}
}
}
}
