List members
members.list(**kwargs) -> PageNumberPage<MemberListResponse { id, first_name, last_name, 3 more } >
GET/v2/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, or exact member id).
List members
require "vitable_connect"
vitable_connect = VitableConnect::Client.new(
api_key: "My API Key",
environment: "environment_1" # defaults to "production"
)
page = vitable_connect.members.list
puts(page){
"data": [
{
"id": "mbr_abc123def456",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone": "4155550100",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102"
}
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"total_pages": 1
}
}Returns Examples
{
"data": [
{
"id": "mbr_abc123def456",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone": "4155550100",
"address": {
"address_line_1": "123 Main Street",
"address_line_2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102"
}
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"total_pages": 1
}
}