Volunteers
This object represents a volunteer application within a convention.
Search for volunteers
Paginate through the volunteer list.
Authentication
Service Integration with
volunteer:read scope.Request
nextPagestring (optional)A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the
nextPage parameter from the previous response for each subsequent request.limitnumber (optional)The maximum number of results to return, between 1 and 100. Defaults to 100.
Response
Show child attributes
departmentsArray of DepartmentAssignmentSet of departments where the volunteer has expressed a preference or has an assignment.
Show child attributes
Show child attributes
preferredNamestring (optional)nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
optionsArray of OptionA set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
{
"nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
"limit": 100,
}
{
"data": [
{
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"contactMethods": [
{
"name": "discord",
"isPrimary": true,
"value": "Username#1234"
},
],
"departments": [
{
"id": "1234",
"states": ["experience", "interest"],
"name": "Registration"
},
],
"user": {
"id": "1234",
"firstName": "John",
"lastName": "Doe",
"username": "jdoe",
"preferredName": "Johnny",
"phone": "+15555555555",
"email": "[email protected]",
},
"options": [
{
"name": "jump",
"type": "select",
"value": "How high?"
},
],
},
],
"nextPage": null,
}
Retrieve a user's volunteer record
Returns the volunteer object for the specified user.
Authentication
Service Integration with
volunteer:read scope.Response
Show child attributes
departmentsArray of DepartmentAssignmentSet of departments where the volunteer has expressed a preference or has an assignment.
Show child attributes
Show child attributes
preferredNamestring (optional)nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
optionsArray of OptionA set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
curl https://reg.cces.dev/api/v0/users/{id}/volunteer \
-H "Authorization: Bearer <token>"
{
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"contactMethods": [
{
"name": "discord",
"isPrimary": true,
"value": "Username#1234"
},
],
"departments": [
{
"id": "1234",
"states": ["experience", "interest"],
"name": "Registration"
},
{
"id": "5678",
"states": ["avoid"],
"name": "HR"
}
],
"user": {
"id": "1234",
"firstName": "John",
"lastName": "Doe",
"username": "jdoe",
"preferredName": "Johnny",
"phone": "+15555555555",
"email": "[email protected]",
},
"options": [
{
"name": "jump",
"type": "select",
"value": "How high?"
},
]
}
Retrieve list of departments
Returns the list of volunteer departments.
Authentication
Service Integration with
volunteer:read scope.Response
Show child attributes
preferredNamestring (optional)nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
curl https://reg.cces.dev/api/v0/volunteers/departments \
-H "Authorization: Bearer <token>"
[
{
"id": "1",
"email": "[email protected]",
"name": "Information Technology",
"publiclyVisible": true,
"leads": [
{
"id": "1234",
"firstName": "Bob",
"lastName": "Smith",
"username": "bobsmith",
"preferredName": "Sphere",
"phone": "+11112223333",
"email": "[email protected]"
}
]
}
]