---
title: "Search user groups by name, ID, and mobile number"
method: GET
path: "/userGroup2/search"
---

# Search user groups by name, ID, and mobile number

`GET /userGroup2/search`

Retrieves the details of a specific group using the unique ID or external ID of the group.

## Query parameters

- `q` string, required
- `id` string, required
- `offset` string
- `limit` string

## Response `200`

200

- union
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `total` integer
    - `data` object[]
      - `groupId` integer
      - `groupName` string
      - `groupStatus` string
      - `groupExternalId` string
      - `firstName` string
      - `lastName` string
      - `primaryMemberId` integer
      - `email` string
      - `mobile` string
      - `totalMembers` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
  - object
    - `id` integer
    - `externalId` string
    - `groupStatus` string
    - `createdBy` integer
    - `createdOn` string
    - `groupName` string
    - `maxGroupSize` integer
    - `expiredPoints` object[]
      - `points` integer
      - `expiredOn` string
      - `programId` integer
      - `expiredPointsSummary` object[]
        - `paType` string
        - `paId` integer
        - `expiryUpdateReasonType` string
        - `expiryUpdateReasonNote` string
        - `newExpiryDate` string
        - `eventDate` string
        - `points` integer
        - `strategyName` string
    - `expirySchedules` object[]
      - `points` integer
      - `expiryDate` string
      - `programId` integer
    - `gapToUpgrade` object[]
      - `upgradeBasedOn` string
      - `upgradeThreshold` integer
      - `customerUpgradeEntityValues` object
        - `currentValue` integer
        - `gapToUpgrade` integer
        - `valueValidUpto` string
        - `setCurrentValue` boolean
        - `setGapToUpgrade` boolean
        - `setValueValidUpto` boolean
      - `setUpgradeBasedOn` boolean
      - `setUpgradeEntityIdentifiers` boolean
      - `setUpgradeThreshold` boolean
      - `setCustomerUpgradeEntityValues` boolean
    - `warnings` unknown[]
      - unknown
  - object
    - `pagination` object
      - `limit` integer
      - `offset` integer
      - `total` integer
    - `data` object[]
      - `groupId` integer
      - `groupName` string
      - `groupStatus` string
      - `groupExternalId` string
      - `firstName` string
      - `lastName` string
      - `primaryMemberId` integer
      - `email` string
      - `mobile` string
      - `totalMembers` integer
      - `extendedFields` object
        - `usergroup2_automation_extended_field` integer
    - `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)