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: ""

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

Example: ""

birthDateSTRING

Member Birth Date

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

loyaltyPointINTEGER

Loyalty Point

Example: 0

countryCodeSTRING

Country code of member contact number

Example: "60"

phoneNumberSTRING

Phone number of member

Example: "167367171"

profileImageUrlSTRING

Member profile image URL

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

memberTierSTRING

Member tier

Example: null

statusSTRING

Member status

Example: "ACTIVE"

createdAtDATETIME

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: 3