Contacts

List volunteers

All non-deleted contacts on this account's roster, ordered by name. Requires read.

get/api/v1/contacts

Request

Base URL: https://volunteerreminder.com
URL: https://volunteerreminder.com/api/v1/contacts
Auth: HTTP bearer

Response

The roster.

idnumber required

Contact id.

full_namestring required

Display name, shown on the roster and in reminder text.

first_namestring nullable required

First name, or null if not recorded separately.

last_namestring nullable required

Last name, or null if not recorded separately.

email_addressstring nullable required

Email address reminders may be sent to, or null.

mobile_phonestring nullable required

Mobile phone in E.164 format, used for SMS reminders, or null.

land_phonestring nullable required

Landline phone number (not SMS-capable, informational only), or null.

group_idnumber nullable required

Id of the group this contact belongs to, or null.

group_namestring nullable required

Display name of the group, or null when ungrouped.

notesstring nullable required

Free-text notes about the contact, or null.

created_atnumber required

Epoch milliseconds (UTC) the contact was created.

Example response

[
  {
    "id": 4021,
    "full_name": "Ann Adams",
    "first_name": "Ann",
    "last_name": "Adams",
    "email_address": "ann@example.org",
    "mobile_phone": "+15125550100",
    "land_phone": "+15125550199",
    "group_id": 12,
    "group_name": "Sunday greeters"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.