---
title: "Retrieve user group members list"
method: GET
path: "/userGroup2"
---

# Retrieve user group members list

`GET /userGroup2`

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

## Query parameters

- `id` integer, required
- `externalId` string, required
- `primaryMemberDetails` boolean
- `programDetails` boolean
- `expiredPoints` boolean
- `expirySchedules` boolean
- `gapToUpgradeFor` boolean
- `gapToRenewFor` boolean
- `companyDetails` boolean

## Response `200`

200

- object
  - `id` integer
  - `externalId` string
  - `groupStatus` string
  - `fleetGroupUsers` object[]
    - `userId` integer
    - `groupId` integer
    - `defaultGroup` boolean
    - `active` boolean
    - `primaryMember` boolean
  - `createdBy` integer
  - `createdOn` string
  - `groupName` string
  - `maxGroupSize` integer
  - `lifeTimePurchases` integer
  - `expiredPoints` unknown[]
    - unknown
  - `expirySchedules` object[]
    - `points` integer
    - `expiryDate` string
    - `programId` integer
  - `gapToUpgrade` object[]
    - `upgradeBasedOn` string
    - `upgradeThreshold` integer
    - `customerUpgradeEntityValues` object
      - `currentValue` integer
      - `gapToUpgrade` integer
      - `valueValidUpto` string
  - `totalActiveMembers` integer
  - `totalExitedMembers` integer
  - `warnings` object[]
    - `status` boolean
    - `code` integer
    - `message` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)