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

# Retrieve user group members

`GET /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.

## Query parameters

- `source` string
- `identifierName` string
- `identifierValue` string
- `includeCardDetails` boolean
- `includeStatusDetails` boolean
- `paginationDetails` boolean
- `limit` integer
- `offset` integer
- `sortBy` string
- `sortOrder` 'ASC' | 'DESC'
- `fromDate` string, date
- `toDate` string, date

## Response `200`

200

- object
  - `pagination` object
    - `limit` integer
    - `offset` integer
    - `sortBy` string
    - `sortOrder` string
    - `total` integer
  - `data` object[]
    - `fleetUserId` integer
    - `firstName` string
    - `lastName` string
    - `joinedOn` string
    - `permissions` string
    - `pointsContributed` number
    - `email` string
    - `mobile` string
    - `role` string
    - `roleCode` string
    - `identifiers` object[]
      - `type` string
      - `value` string
    - `cards` object[]
      - `cardId` integer
      - `issuedDate` string
      - `createdDate` string
      - `expiryDays` integer
      - `expiryDate` string
      - `seriesName` string
      - `seriesId` integer
      - `seriesCode` string
      - `cardNumber` string
      - `type` string
      - `customerId` integer
      - `maxActiveCards` integer
      - `orgId` integer
      - `entityId` integer
      - `customFields` object
      - `transactionNotAllowed` boolean
      - `statusInfo` object
        - `id` integer
        - `isActive` boolean
        - `label` string
        - `status` string
        - `labelId` integer
        - `reason` string
        - `createdBy` integer
        - `createdOn` string
        - `autoUpdateTime` string
        - `entityId` integer
        - `actions` unknown[]
          - unknown
    - `inActive` boolean
    - `primaryMember` boolean
  - `warnings` unknown[]
    - unknown
  - `errors` unknown[]
    - unknown

## 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/revisions/de241f2ed9b3/schema)