Get Loyalty Members

List all loyalty members under the merchant.

When to Use

▾

Use this endpoint when:

• Displaying a member directory in your dashboard
• Exporting members for reporting

How to Use

▾

Endpoint

GET/v3/loyalty/members

GET /v3/loyalty/members with signed authentication headers.

---

Request Parameters

▾

No request body. Authenticated headers only.

Response Parameters

▾

itemsARRAY

Array of loyalty member objects

idSTRING

Member ID

Example: "2940921291529816182"

nameSTRING

Member name

Example: "Gan"

emailSTRING

Email address of member

Example: "[email protected]"

nricSTRING

IC Number

Example: ""

passportSTRING

Passport number (empty if not applicable)

Example: ""

addressOBJECT

Member address

addressLine1STRING

Address 1

Example: ""

addressLine2STRING

Address 2

Example: ""

postcodeSTRING

Postcode

Example: ""

citySTRING

City

Example: ""

stateSTRING

State

Example: ""

countrySTRING

Country

Example: ""

genderSTRING

Gender

Example: ""

stateSTRING

Member state (empty if not set)

Example: ""

referralCodeSTRING

Member's referral code (empty if not set)

Example: ""

birthDateSTRING

Member Birth Date

Example: "0001-01-01T00:00:00Z"

loyaltyPointINTEGER

Loyalty point balance

Example: 0

creditINTEGER

Credit balance

Example: 0

countryCodeSTRING

Country code of member contact number

Example: "60"

phoneNumberSTRING

Phone number of member

Example: "187824152"

profileImageURLSTRING

Member profile image URL

Example: "https://storage.googleapis.com/rm-sandbox-asset/img/avatar.png"

hasPinCodeBOOLEAN

User Pin

Example: true

memberTierOBJECT

Member tier details (null if not tiered)

keySTRING

Member tier key (internal usage)

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIdChFMb3lhbHR5TWVtYmVyVGllchCzz874m57FiRY"

labelSTRING

Member tier label

Example: "Diamond"

minimumPointINTEGER

Minimum loyalty point required for this tier

Example: 10000

descriptionARRAY

Member tier description

Example: ["Diamond"]

discountOBJECT

Tier discount details (null if none)

createdAtDATETIME

Tier creation date time

Example: "2020-05-28T03:55:21Z"

updatedAtDATETIME

Tier last update date time

Example: "0001-01-01T00:00:00Z"

statusSTRING

Member status

Example: "ACTIVE"

createdDateTimeDATETIME

Creation date time

Example: "2018-09-19T10:00:21Z"

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"

metaOBJECT

Pagination metadata

countINTEGER

Total number of members returned

Example: 50

cursorSTRING

Cursor for the next page (null if no more results)

Example: "eyJzaWduYXR1cmUiOiJ0WDN0YUcrS2xteE5ZYWNHTjVHUUVQVGx1Rms9IiwibmV4dCI6IkVoSUtCazFsYldKbGNoQzZ2WVQ3bjZyYjdCVVNHUW9OVFdWdFltVnlVSEp2Wm1sc1pSQ2RvZkdOcEtyYjdCVSJ9"