Skip to main content

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

link
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.
link
limitnumber (optional)
The maximum number of results to return, between 1 and 100. Defaults to 100.

Response

link
createdAtISO-8601 Date
The date the volunteer record was created.
link
updatedAtISO-8601 Date
The date the volunteer record was last updated.
link
contactMethodsArray of ContactMethod
Set of contact methods provided by the volunteer.
Show child attributes
link
namestring
The name of the contact method.
link
isPrimaryboolean
Whether this contact method is the preferred way of contacting the volunteer.
link
valuestring
An arbitrary string identifier for the contact method.
link
departmentsArray of DepartmentAssignment
Set of departments where the volunteer has expressed a preference or has an assignment.
Show child attributes
link
idstring
The unique identifier of the department.
link
statesArray of strings
The flags indicating the volunteer's preference or assignment for the department.
Possible values: experience, interest, avoid, assignment, request
link
namestring
The name of the department.
link
userUser
The user object for the volunteer.
Show child attributes
link
idstring
The unique identifier of the user.
link
firstNamestring
The first name of the user.
link
lastNamestring
The last name of the user.
link
usernamestring
The username of the user.
link
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.
link
phonestring
The phone number of the user in E.164 format.
link
emailstring
The email address of the user.
link
optionsArray of Option
A set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
link
namestring
The name of the option as defined by the event.
link
typestring
The type of the option as defined by the event.
Possible values: select, multi, text, number.
link
valuenumber, string, or Array of string
The value of the option.
POST /api/v0/volunteers/searchcURL
{
  "nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
  "limit": 100,
}
Responseapplication/json
{
  "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": "johnny.test@concat.systems",
      },
      "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

link
createdAtISO-8601 Date
The date the volunteer record was created.
link
updatedAtISO-8601 Date
The date the volunteer record was last updated.
link
contactMethodsArray of ContactMethod
Set of contact methods provided by the volunteer.
Show child attributes
link
namestring
The name of the contact method.
link
isPrimaryboolean
Whether this contact method is the preferred way of contacting the volunteer.
link
valuestring
An arbitrary string identifier for the contact method.
link
departmentsArray of DepartmentAssignment
Set of departments where the volunteer has expressed a preference or has an assignment.
Show child attributes
link
idstring
The unique identifier of the department.
link
statesArray of strings
The flags indicating the volunteer's preference or assignment for the department.
Possible values: experience, interest, avoid, assignment, request
link
namestring
The name of the department.
link
userUser
The user object for the volunteer.
Show child attributes
link
idstring
The unique identifier of the user.
link
firstNamestring
The first name of the user.
link
lastNamestring
The last name of the user.
link
usernamestring
The username of the user.
link
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.
link
phonestring
The phone number of the user in E.164 format.
link
emailstring
The email address of the user.
link
optionsArray of Option
A set of options, customized by the event, that contain arbitrary data provided by the volunteer.
Show child attributes
link
namestring
The name of the option as defined by the event.
link
typestring
The type of the option as defined by the event.
Possible values: select, multi, text, number.
link
valuenumber, string, or Array of string
The value of the option.
GET /api/v0/users/:id/volunteercURL
curl https://reg.cces.dev/api/v0/users/{id}/volunteer \
  -H "Authorization: Bearer <token>"
Responseapplication/json
{
  "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": "johnny.test@concat.systems",
  },
  "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

link
idstring
The unique identifier of the department record.
link
namestring
The date the volunteer record was created.
link
emailemail
The date the volunteer record was last updated.
link
publiclyVisibleboolean
Department is publicly visible to all users applying for a position.
link
leadsArray of User
List of users who are assigned as leads for this department
Show child attributes
link
idstring
The unique identifier of the user.
link
firstNamestring
The first name of the user.
link
lastNamestring
The last name of the user.
link
usernamestring
The username of the user.
link
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.
link
phonestring
The phone number of the user in E.164 format.
link
emailstring
The email address of the user.
GET /api/v0/volunteers/departmentscURL
curl https://reg.cces.dev/api/v0/volunteers/departments \
  -H "Authorization: Bearer <token>"
Responseapplication/json
[
  {
    "id": "1",
    "email": "support@concat.org",
    "name": "Information Technology",
    "publiclyVisible": true,
    "leads": [
      {
        "id": "1234",
        "firstName": "Bob",
        "lastName": "Smith",
        "username": "bobsmith",
        "preferredName": "Sphere",
        "phone": "+11112223333",
        "email": "bob@concat.org"
      }
    ]
  }
]