The getMember API call is used to retrieve information about an existing member's account.



Sample Request URL


http://{Your_API_URL}?q=/getMember



Input Parameters


ParameterDescriptionRequired
apikeyAPI key from MemberMouse API CredentialsYes
apisecretAPI secret from MemberMouse API CredentialsYes
member_idID of the member to updateYes, if email address is not provided
emailEmail address of the member to updateYes, if member ID is not provided


Response Codes


  • 200 - Success

  • 409 - Could not find member with the member ID or email address passed



Response Data


ParameterDescription
member_idThe member's ID in MemberMouse
first_nameThe member's first name
last_nameThe member's last name
registeredThe date the member registered
cancellation_dateThe date the member's account will be canceled. This will only be set if the member's account status is pending cancellation.
last_logged_inThe date the member last logged in
last_updatedThe date the member's account was last updated
days_as_memberThe number of days the member has been a member
statusThe status of the member's account. 1 (Active), 2 (Canceled), 3 (Locked), 4 (Paused), 5 (Overdue), 6 (Pending Activation), 7 (Error), 8 (Expired), 9 (Pending Cancellation)
status_nameThe name of status on the member's account.
is_complimentaryThis indicates if the member's account is complimentary or not. It will be set to true if the account is complimentary and false if not.
membership_levelThe ID of the member's membership level
membership_level_nameThe name of the member's membership level
usernameThe member's username
emailThe member's email address
phoneThe member's phone number
billing_addressThe member's billing address
billing_cityThe member's billing city
billing_stateThe member's billing state
billing_zipThe member's billing zip code
billing_countryThe member's billing country
shipping_addressThe member's shipping address
shipping_cityThe member's shipping city
shipping_stateThe member's shipping state
shipping_zipThe member's shipping zip code
shipping_countryThe member's shipping country
bundlesAn array of bundles applied to the member's account. See table below for parameters available for each bundle.
custom_fieldsAn array of custom fields associated with the member's account. See the table below for parameters available for each custom field.


Bundle Data


Bundle data is stored as an array of items in the bundles attribute as part of the response data. The table below outlines the available parameters for each item in the bundles array.


ParameterDescription
idThe ID of the bundle applied to the member's account
nameThe name of the bundle applied to the member's account
days_with_bundleThe number of days the bundle has been applied to the member's account
statusThe status of the bundle applied to the member's account. 1 (Active), 2 (Canceled), 3 (Locked), 4 (Paused), 5 (Overdue), 6 (Pending Activation), 7 (Error), 8 (Expired), 9 (Pending Cancellation)
status_nameThe name of status of the bundle applied to the member's account.
is_complimentaryThis indicates if the bundle is complimentary or not. It will be set to true if the bundle is complimentary and false if not.
date_addedThe date the bundle was first applied to the member's account
last_updatedThe date the bundle was last updated on the member's account


Custom Field Data


Custom field data is stored as an array of items in the custom_field attribute as part of the response data. The table below outlines the available parameters for each item in the custom fields array.


ParameterDescription
idThe ID of the custom field
nameThe name of the custom field
valueThe value stored in the custom field on the member's account