Get member list

POST 
/openapi/2026-01/loyalty/members

Query members by member ID or email, up to 200 per request

Request

application/json

Body

Bodyrequired

search_typestringrequired

Member locator type: member_id or email

search_valuesstring[]required

Locator values to query. Up to 200 per request

Example

{
  "search_type": "string",
  "search_values": [
    "string"
  ]
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
members object[]
Matched members
Array [
member_idstring
Member ID
emailstring
Member email
phonestring
Member phone
first_namestring
Member first name
last_namestring
Member last name
current_tier_namestring
Current tier name
created_atstring
Member created at, ISO-8601
transactions_amountstring
Accumulated transactions amount as a decimal string
birthdaystring
Member birthday; empty string when not set
statusstring
Member status: active / inactive / ...
tagsstring[]
Member tags
activated_atstring
Loyalty activation time, ISO-8601; empty when not activated
first_order_atstring
First order time, ISO-8601; empty when none
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "members": [
      {
        "member_id": "string",
        "email": "string",
        "phone": "string",
        "first_name": "string",
        "last_name": "string",
        "current_tier_name": "string",
        "created_at": "string",
        "transactions_amount": "string",
        "birthday": "string",
        "status": "string",
        "tags": [
          "string"
        ],
        "activated_at": "string",
        "first_order_at": "string"
      }
    ]
  }
}