Get member group detail

GET 
/openapi/2027-01/loyalty/member-groups/:member_group_id

Return the detail of a specific member segment

Request

Path Parameters

member_group_id stringrequired

Member group ID from path

Query Parameters

cursor string

Members pagination cursor

limit int32

Members page size

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
Get member group detail response
member_group_idstring
namestring
is_real_timeboolean
member_countint64
created_atstring
updated_atstring
member_condition object
Member condition expression (recursive tree)
keystring
operatorstring
valueGoogleProtobufValue
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
extra object
Member condition extra config (time window, categories, products, regions)
time_rangestring
Time range window: all / 7d / 30d
categories object[]
Categories filter, 2-level nested array ([["a","a-1"],["b"]])
Array [
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
]
product_idsstring[]
Product id list
country_and_province object
Country+province map: key=country code, value=province codes (["ALL"]=whole country)
property name* ListValue
ListValue is a wrapper around a repeated field of values.
The JSON representation for ListValue is JSON array.
valuesGoogleProtobufValue[]
Repeated field of dynamically typed values.
relationstring
childrenundefined[]
members object
Paginated members block inside member group detail
items object[]
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
]
next_cursorstring
has_moreboolean
limitint32

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "member_group_id": "string",
    "name": "string",
    "is_real_time": true,
    "member_count": 0,
    "created_at": "string",
    "updated_at": "string",
    "member_condition": {
      "key": "string",
      "operator": "string",
      "extra": {
        "time_range": "string",
        "categories": [
          {
            "values": [
              null
            ]
          }
        ],
        "product_ids": [
          "string"
        ],
        "country_and_province": {}
      },
      "relation": "string",
      "children": [
        null
      ]
    },
    "members": {
      "items": [
        {
          "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"
        }
      ],
      "next_cursor": "string",
      "has_more": true,
      "limit": 0
    }
  }
}