## List members

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

### Query Parameters

- `limit: optional number`

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

- `page: optional number`

  Page number (default: 1)

- `search: optional string`

  Case-insensitive search across member name and email; exact match on member id

### Returns

- `data: array of  { id, first_name, last_name, 3 more }`

  - `id: string`

    Unique member identifier with 'mbr_' prefix

  - `first_name: string`

    Member's legal first name

  - `last_name: string`

    Member's legal last name

  - `address: optional  { address_line_1, city, state, 2 more }`

    Member's residential address

    - `address_line_1: string`

      Primary street address

    - `city: string`

      City name

    - `state: "AL" or "AK" or "AZ" or 59 more`

      * `AL` - AL
      * `AK` - AK
      * `AZ` - AZ
      * `AR` - AR
      * `CA` - CA
      * `CO` - CO
      * `CT` - CT
      * `DC` - DC
      * `DE` - DE
      * `FL` - FL
      * `GA` - GA
      * `HI` - HI
      * `ID` - ID
      * `IL` - IL
      * `IN` - IN
      * `IA` - IA
      * `KS` - KS
      * `KY` - KY
      * `LA` - LA
      * `ME` - ME
      * `MD` - MD
      * `MA` - MA
      * `MI` - MI
      * `MN` - MN
      * `MS` - MS
      * `MO` - MO
      * `MT` - MT
      * `NE` - NE
      * `NV` - NV
      * `NH` - NH
      * `NJ` - NJ
      * `NM` - NM
      * `NY` - NY
      * `NC` - NC
      * `ND` - ND
      * `OH` - OH
      * `OK` - OK
      * `OR` - OR
      * `PA` - PA
      * `RI` - RI
      * `SC` - SC
      * `SD` - SD
      * `TN` - TN
      * `TX` - TX
      * `UT` - UT
      * `VT` - VT
      * `VA` - VA
      * `WA` - WA
      * `WI` - WI
      * `WV` - WV
      * `WY` - WY
      * `PR` - PR
      * `GU` - GU
      * `AS` - AS
      * `VI` - VI
      * `MP` - MP
      * `MH` - MH
      * `PW` - PW
      * `FM` - FM
      * `AE` - AE
      * `AA` - AA
      * `AP` - AP

      - `"AL"`

      - `"AK"`

      - `"AZ"`

      - `"AR"`

      - `"CA"`

      - `"CO"`

      - `"CT"`

      - `"DC"`

      - `"DE"`

      - `"FL"`

      - `"GA"`

      - `"HI"`

      - `"ID"`

      - `"IL"`

      - `"IN"`

      - `"IA"`

      - `"KS"`

      - `"KY"`

      - `"LA"`

      - `"ME"`

      - `"MD"`

      - `"MA"`

      - `"MI"`

      - `"MN"`

      - `"MS"`

      - `"MO"`

      - `"MT"`

      - `"NE"`

      - `"NV"`

      - `"NH"`

      - `"NJ"`

      - `"NM"`

      - `"NY"`

      - `"NC"`

      - `"ND"`

      - `"OH"`

      - `"OK"`

      - `"OR"`

      - `"PA"`

      - `"RI"`

      - `"SC"`

      - `"SD"`

      - `"TN"`

      - `"TX"`

      - `"UT"`

      - `"VT"`

      - `"VA"`

      - `"WA"`

      - `"WI"`

      - `"WV"`

      - `"WY"`

      - `"PR"`

      - `"GU"`

      - `"AS"`

      - `"VI"`

      - `"MP"`

      - `"MH"`

      - `"PW"`

      - `"FM"`

      - `"AE"`

      - `"AA"`

      - `"AP"`

    - `zipcode: string`

      ZIP code (5 or 9 digit)

    - `address_line_2: optional string`

      Secondary street address (apt, suite, etc.)

  - `email: optional string`

    Email address

  - `phone: optional string`

    Phone number (10-digit US domestic string)

- `pagination: Pagination`

  Pagination metadata for list responses.

  - `limit: number`

    Items per page

  - `page: number`

    Current page number

  - `total: number`

    Total number of items

  - `total_pages: number`

    Total number of pages

### Example

```http
curl https://api.vitablehealth.com/v2/members \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"
```

#### Response

```json
{
  "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
  }
}
```