v1

latestOpenAPI 3.0.02026-08-062438369.6 KB
Users

List / find Users

Returns a paginated list of users who are members of your organization. Use this endpoint to sync volunteer records into an external system, or to search for specific users by name or email before creating or updating them. Results are scoped to your organization — users in other organizations are not returned.

get/users

Query parameters

pageinteger

Page number (if paging results).

name_likestring

A name, or part of a name, to search for. This searches both the first and last name.

email_likestring

An email address, or part of an address, to search for.

created_beforestring date-time

Date the User account was created on or before.

created_afterstring date-time

Date the User account was created on or after

updated_beforestring date-time

Date the user was updated on or before.

updated_afterstring date-time

Date the user was updated on or after

Response

Returns the paginated list of users who are members of your organization. The response includes pagination links and meta fields to navigate additional pages.

Example response

{
  "data": [
    {
      "type": "user",
      "id": "1",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "email": "person@vomo.org",
      "address": "610 Elm St, McKinney, TX 75069, USA",
      "phone": "1234567890",
      "birthday": "1975-12-01",
      "gender": "M",
      "updated_at": "2016-03-07T07:49:41+00:00",
      "created_at": "2016-03-07T07:49:41+00:00",
      "user_status": "VERIFIED",
      "membership_status": "ACCEPTED",
      "membership_role": "VOLUNTEER"
    }
  ]
}