Members

List members

Retrieves a paginated list of the members in the authenticated organization's book — identity, contact details, and address. The book covers members reached through an employer in the organization's book as well as members of a group it owns. Supports free-text search (name, email, phone number, or exact member id).

get/v2/members

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v2/members
  • Auth: HTTP bearer

Query parameters

limitinteger

Items per page (default: 20, max: 100)

pageinteger

Page number (default: 1)

searchstring

Case-insensitive search across member name, email, and phone number; exact match on member id (prefixed or raw uuid)

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Response

Changes

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