---
title: "List volunteers"
method: GET
path: "/api/v1/contacts"
tags: ["Contacts"]
---

# List volunteers

`GET /api/v1/contacts`

## Request

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

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

## Response `200`

The roster.

- Contact[]
  - `id` number, required: Contact id.
  - `full_name` string, required: Display name, shown on the roster and in reminder text.
  - `first_name` string, nullable, required: First name, or `null` if not recorded separately.
  - `last_name` string, nullable, required: Last name, or `null` if not recorded separately.
  - `email_address` string, nullable, required: Email address reminders may be sent to, or `null`.
  - `mobile_phone` string, nullable, required: Mobile phone in E.164 format, used for SMS reminders, or `null`.
  - `land_phone` string, nullable, required: Landline phone number (not SMS-capable, informational only), or `null`.
  - `group_id` number, nullable, required: Id of the group this contact belongs to, or `null`.
  - `group_name` string, nullable, required: Display name of the group, or `null` when ungrouped.
  - `notes` string, nullable, required: Free-text notes about the contact, or `null`.
  - `created_at` number, required: Epoch milliseconds (UTC) the contact was created.

## Other responses

- `401`: Missing or invalid API key.
- `403`: The API key lacks a scope required by this endpoint.

---

[API](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api.md) · [All operations](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/llms.txt) · [OpenAPI document](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/revisions/f8e7e26ba96f?raw)