Skip to navigation

List

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).

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Headers

X-Vitable-OrganizationstringOptional

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.

Query parameters

limitintegerOptional1-100Defaults to 20

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

pageintegerOptional>=1Defaults to 1

Page number (default: 1)

searchstringOptional

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

Response headers

X-RateLimit-Limitinteger
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaininginteger
Number of requests remaining in the current rate limit window
X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

datalist of objects
This page of members.
paginationobject

Page metadata. Request the next page by incrementing page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error