Get Member Profile
Member Management
Get Member Profile
Retrieve complete profile details for a member by their RelationReference.
GET
Get Member Profile
Returns the full profile for a member identified by their
RelationReference. Use this to display member details, check tier status, or retrieve the internal Id required by Update Profile. If you only know the member’s email or another unique attribute — not their RelationReference — use Get Member by Attribute instead.
Responses
200 — Success
200 — Success
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | true |
results.ErrorCode | string | 000 |
results.ReturnObject.Id | integer | Internal member ID — required for Update Profile |
results.ReturnObject.FullName | string | Member’s full name |
results.ReturnObject.Email | string | Member’s email address |
results.ReturnObject.MobileNumber | string | Member’s mobile number |
results.ReturnObject.DOB | string (date-time) | Member’s date of birth |
results.ReturnObject.Gender | string | M, F, or O |
results.ReturnObject.Address | string | Member’s address |
results.ReturnObject.Status | integer | Account status code — 1=Active |
results.ReturnObject.IsAccountActivated | boolean | Whether the member has completed activation |
results.ReturnObject.TierName | string | Current loyalty tier name (e.g. Silver, Gold, Platinum) |
results.ReturnObject.TotalPoints | integer | Current points balance |
results.ReturnObject.EnrollmentDate | string (date-time) | Date the member was enrolled |
results.ReturnObject.ActivatedDate | string (date-time) | Date the member activated their account |
results.ReturnObject.LastLoggedIn | string (date-time) | Last login timestamp |
results.ReturnObject.IsAccrualAllowed | boolean | Whether the member can earn points |
results.ReturnObject.CustomerSegment | string | Segment assigned to the member (e.g. DEFAULT) |
results.ReturnObject.PreferredLanguage | string | Member’s preferred language code (e.g. EN) |
results.ReturnObject.RelationReference | string | The member’s RelationReference (CID) |
results.ReturnObject.ProgramId | integer | Program the member belongs to |
404 — Not Found
404 — Not Found
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | false |
results.ErrorCode | string | Error code |
results.ExceptionMessage | string | Error description |
Error Codes
| Code | ExceptionMessage | Cause |
|---|---|---|
000 | Success | Member profile returned |
103 | Member does not exist | relation_reference not found in the program |
109 | Member record not available | Member exists but the record could not be retrieved |
999 | Bad request | Missing or malformed query parameters |
Authorizations
JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.
Query Parameters
Your loyalty program ID
Example:
19
Relation type. Use 4 for customers.
Example:
4
The member's unique reference. URL-encode before passing (e.g. jane.doe%40example.com).
Example:
"jane.doe@example.com"
Response
Member profile