v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve user group members list

This API allows you to retrieve details of members in the user group.

get/userGroup2

Query parameters

idinteger required

Unique ID of the user group. Either id or externalId is mandatory.

externalIdstring required

External ID of the group. Either id or externalId is mandatory.

primaryMemberDetailsboolean

Primary member details of the group.

programDetailsboolean

Details of the program tier

expiredPointsboolean

Expired points of the group

expirySchedulesboolean

gapToUpgradeForboolean

gapToRenewForboolean

companyDetailsboolean

Details of the company

Response

200

idinteger

externalIdstring

groupStatusstring

createdByinteger

createdOnstring

groupNamestring

maxGroupSizeinteger

lifeTimePurchasesinteger

totalActiveMembersinteger

totalExitedMembersinteger

Example response

{
  "id": 3839,
  "externalId": "bukl123",
  "groupStatus": "ACTIVE",
  "fleetGroupUsers": [
    {
      "userId": 134094571,
      "groupId": 3839,
      "active": true,
      "primaryMember": true
    }
  ],
  "createdBy": 75036445,
  "createdOn": "2023-04-14T04:29:03Z",
  "groupName": "Buklfleetgroup",
  "maxGroupSize": 110,
  "lifeTimePurchases": 30000,
  "expirySchedules": [
    {
      "points": 700,
      "expiryDate": "2024-04-30",
      "programId": 469
    }
  ],
  "gapToUpgrade": [
    {
      "upgradeBasedOn": "CURRENT_POINTS",
      "upgradeThreshold": 3000,
      "customerUpgradeEntityValues": {
        "currentValue": 700,
        "gapToUpgrade": 2300,
        "valueValidUpto": "2123-04-14"
      }
    }
  ],
  "totalActiveMembers": 7,
  "warnings": [
    {
      "code": 1656,
      "message": "Fleet group do not have a mapped hierarchy"
    }
  ]
}