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
| Parameter | Description | Required |
apikey | API key from MemberMouse API Credentials | Yes |
apisecret | API secret from MemberMouse API Credentials | Yes |
member_id | ID of the member to update | Yes, if email address is not provided |
email | Email address of the member to update | Yes, if member ID is not provided |
Response Codes
200- Success409- Could not find member with the member ID or email address passed
Response Data
| Parameter | Description |
member_id | The member's ID in MemberMouse |
first_name | The member's first name |
last_name | The member's last name |
registered | The date the member registered |
cancellation_date | The date the member's account will be canceled. This will only be set if the member's account status is pending cancellation. |
last_logged_in | The date the member last logged in |
last_updated | The date the member's account was last updated |
days_as_member | The number of days the member has been a member |
status | The 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_name | The name of status on the member's account. |
is_complimentary | This 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_level | The ID of the member's membership level |
membership_level_name | The name of the member's membership level |
username | The member's username |
email | The member's email address |
phone | The member's phone number |
billing_address | The member's billing address |
billing_city | The member's billing city |
billing_state | The member's billing state |
billing_zip | The member's billing zip code |
billing_country | The member's billing country |
shipping_address | The member's shipping address |
shipping_city | The member's shipping city |
shipping_state | The member's shipping state |
shipping_zip | The member's shipping zip code |
shipping_country | The member's shipping country |
bundles | An array of bundles applied to the member's account. See table below for parameters available for each bundle. |
custom_fields | An 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. Data will only be returned for bundles that are active on the member's account. The table below outlines the parameters returned for each item in the bundles array.
| Parameter | Description |
id | The ID of the bundle applied to the member's account |
name | The name of the bundle applied to the member's account |
days_with_bundle | The number of days the bundle has been applied to the member's account |
status | The numeric status of the bundle applied to the member's account. The value may be any of the following: 1 (Active), 4 (Paused), 9 (Pending Cancellation) |
status_name | The name of status of the bundle applied to the member's account. |
is_complimentary | This indicates if the bundle is complimentary or not. It will be set to true if the bundle is complimentary and false if not. |
date_added | The date the bundle was first applied to the member's account |
last_updated | The 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.
| Parameter | Description |
id | The ID of the custom field |
name | The name of the custom field |
value | The value stored in the custom field on the member's account |