Retrieve user group member details

get

https://{host}/v2/userGroup2/members

Retrieves details of all members in a user group, including their roles, identifiers, permissions, and points contributed. Optionally returns card details, customer status information, and pagination.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

source

string

Source in which the group identifier is registered. Required. Supported values: INSTORE, MARTJACK, WECHAT, FACEBOOK, WEB_ENGAGE, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. Case-sensitive.

identifierName

string

Identifier type used to look up the group. Required. Supported value: id (internal group ID).

identifierValue

string

Value of the identifier specified in identifierName. Required. For example, if identifierName is id, pass the numeric group ID.

includeCardDetails

boolean

Pass true to include card details for each member in the response. Defaults to false.

includeStatusDetails

boolean

Pass true to include customer status details for each member's cards in the response. Defaults to false.

paginationDetails

boolean

Pass true to include a pagination object in the response. Defaults to false.

limit

int32

Maximum number of members to return per page. Used with paginationDetails=true.

offset

int32

Starting index for paginated results. Used with paginationDetails=true.

sortBy

string

Field to sort results by. Pass IS_PRIMARY to list the primary member first.

sortOrder

string

enum

Defaults to DESC

Sort direction. Supported values: ASC, DESC. Defaults to DESC.

Allowed:

fromDate

date

Start of the date range to filter members by join date. Format: YYYY-MM-DD HH:MM:SS.

toDate

date

End of the date range to filter members by join date. Format: YYYY-MM-DD HH:MM:SS.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400