latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Retrieve a specific member

Retrieve a specific member based on their key.

get/members/{key}

Path parameters

keystring required

Can be either the member's email address or their numerical ID

Response

All attributes of the specified member

idinteger
firstnamestring
lastnamestring
companystring
emailstring email
genderstring

m, f or o

languagestring

en_ca or fr_ca

joinedOnstring nullable
updatedOnstring nullable
consentTypestring
postalCodestring
countrystring

ISO 3166-1 alpha-2 country code

notestring
birthdatestring nullable
mailingsReceivedinteger
mailingsOpenedinteger
mailingsClickedinteger
customFieldsobject

Example response

{
  "id": 3664823,
  "firstname": "John",
  "lastname": "Doe",
  "company": "John Doe Company inc",
  "email": "john.doe@example.org",
  "gender": "m",
  "language": "fr_ca",
  "joinedOn": "2014-12-09 13:42:48.020",
  "updatedOn": "2014-12-10 12:41:42.020",
  "consentType": "implied",
  "country": "CA",
  "customFields": {
    "1": "This is a test !",
    "2": 1000,
    "3": 1.5,
    "4": "2000-01-01"
  }
}