Get member

members.retrieve(member_id) -> 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

member_id: String

Unique member identifier (mbr_*)

ReturnsExpand Collapse

class MemberRetrieveResponse { data }

Response containing a single member resource.

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: Integer

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

date_of_birth: Date

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_line_1, city, state, 2 more}

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

Secondary street address (apt, suite, etc.)

email: String

Email address

formatemail

gender: :Male | :Female | :Transgender | 2 more

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

Single - Single
Married - Married

One of the following:

:Single

:Married

middle_name: String

Member’s legal middle name

phone: String

Phone number (10-digit US domestic string)

preferred_language: :en | :es | :zh | 3 more

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

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

One of the following:

:Male

:Female

:Other

:Unknown

suffix: :Sr | :Jr | :I | 4 more

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

One of the following:

:Sr

:Jr

:II

:III

:IV

tobacco_status: bool

Whether the member uses tobacco, if known

Get member

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

member = vitable_connect.members.retrieve("mbr_abc123def456")

puts(member)

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