v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve user group 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.

get/userGroup2/members

Query parameters

sourcestring

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.

identifierNamestring

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

identifierValuestring

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

includeCardDetailsboolean

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

includeStatusDetailsboolean

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

paginationDetailsboolean

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

limitinteger

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

offsetinteger

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

sortBystring

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

sortOrder'ASC' | 'DESC'

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

fromDatestring date

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

toDatestring date

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

Response

200

Example response

{
  "pagination": {
    "limit": 20,
    "sortBy": "IS_PRIMARY",
    "sortOrder": "DESC",
    "total": 6
  },
  "data": [
    {
      "fleetUserId": 568077466,
      "firstName": "Father",
      "joinedOn": "2026-02-12",
      "permissions": "allow_points_redemption,allow_points_transfer",
      "email": "father@gmail.com",
      "mobile": "919988123456",
      "role": "PRIMARY",
      "roleCode": "FA",
      "identifiers": [
        {
          "type": "email",
          "value": "father@gmail.com"
        }
      ],
      "cards": [
        {
          "cardId": 1970588,
          "issuedDate": "2022-05-05T17:45:58+05:30",
          "createdDate": "2022-05-05",
          "expiryDays": 10000,
          "expiryDate": "2049-09-20T00:00:00+05:30",
          "seriesName": "ONREGSUN",
          "seriesId": 172,
          "seriesCode": "ONREGSUN",
          "cardNumber": "rego0000000000204800series",
          "type": "DIGITAL",
          "customerId": 421977926,
          "maxActiveCards": 100,
          "orgId": 1442,
          "entityId": 15089282,
          "transactionNotAllowed": true,
          "statusInfo": {
            "id": 1992627,
            "isActive": true,
            "label": "ACTIVE",
            "status": "ACTIVE",
            "labelId": 157,
            "createdBy": 15089282,
            "createdOn": "2022-05-05T17:45:58+05:30",
            "autoUpdateTime": "2022-05-05",
            "entityId": 1970588
          }
        }
      ],
      "inActive": true,
      "primaryMember": true
    }
  ]
}