Get member

client.members.retrieve(, ?): MemberRetrieveResponse { data }

GET/v1/members/{member_id}

Retrieves a member’s profile by ID — identity, demographics, address, contact details, tobacco status, and profile status. Access is scoped to the authenticated principal; a member not visible to the caller returns a 404.

ParametersExpand Collapse

memberID: string

Unique member identifier (mbr_*)

ReturnsExpand Collapse

MemberRetrieveResponse { data }

Response containing a single member resource.

data: Data { id, age, date_of_birth, 14 more }

A member’s profile: identity, contact details, address, demographics, and onboarding status.

id: string

Unique member identifier with ‘mbr_’ prefix

age: number

Member’s age in years, derived from date of birth

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

first_name: string

Member’s legal first name

last_name: string

Member’s legal last name

name: string

Member’s full legal name

status: "onboarded" | "pending_onboarding"

Member profile status (onboarded or pending onboarding)

One of the following:

"onboarded"

"pending_onboarding"

address?: Address | null

Member’s residential address

address_line_1: string

Primary street address

city: string

City name

state: "AL" | "AK" | "AZ" | 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

One of the following:

"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?: string | null

Secondary street address (apt, suite, etc.)

email?: string | null

Email address

formatemail

gender?: "Male" | "Female" | "Transgender" | 2 more | null

Male - Male
Female - Female
Transgender - Transgender
Non-binary - Non Binary
Prefer not to respond - Prefer Not To Respond

One of the following:

"Male"

"Female"

"Transgender"

"Non-binary"

"Prefer not to respond"

marital_status?: "Single" | "Married" | null

Single - Single
Married - Married

One of the following:

"Single"

"Married"

middle_name?: string | null

Member’s legal middle name

phone?: string | null

Phone number (10-digit US domestic string)

preferred_language?: "en" | "es" | "zh" | 3 more | null

en - English
es - Spanish
zh - Chinese
ru - Russian
sw - Swahili
th - Thai

One of the following:

"en"

"es"

"zh"

"ru"

"sw"

"th"

sex_at_birth?: "Male" | "Female" | "Other" | "Unknown" | null

Male - Male
Female - Female
Other - Other
Unknown - Unknown

One of the following:

"Male"

"Female"

"Other"

"Unknown"

suffix?: "Sr" | "Jr" | "I" | 4 more | null

Sr - Sr
Jr - Jr
I - I
II - II
III - III
IV - IV
V - V

One of the following:

"Sr"

"Jr"

"I"

"II"

"III"

"IV"

"V"

tobacco_status?: boolean | null

Whether the member uses tobacco, if known

Get member

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const member = await client.members.retrieve('mbr_abc123def456');

console.log(member.data);

{
  "data": {
    "id": "mbr_abc123def456",
    "name": "Jane Doe",
    "first_name": "Jane",
    "middle_name": null,
    "last_name": "Doe",
    "suffix": null,
    "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"
    },
    "date_of_birth": "1990-04-12",
    "age": 36,
    "sex_at_birth": "Female",
    "gender": "Female",
    "preferred_language": "en",
    "tobacco_status": false,
    "status": "onboarded"
  }
}

Returns Examples

{
  "data": {
    "id": "mbr_abc123def456",
    "name": "Jane Doe",
    "first_name": "Jane",
    "middle_name": null,
    "last_name": "Doe",
    "suffix": null,
    "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"
    },
    "date_of_birth": "1990-04-12",
    "age": 36,
    "sex_at_birth": "Female",
    "gender": "Female",
    "preferred_language": "en",
    "tobacco_status": false,
    "status": "onboarded"
  }
}