---
title: "Get smart groups"
method: GET
path: "/users/v1/smart-groups"
tags: ["Users:v1:Smart Groups"]
---

# Get smart groups

`GET /users/v1/smart-groups`

Retrieves a list of smart groups associated with the account.

## Query parameters

- `id` integer — The unique identifier of the smart group.
- `name` string — The name of the smart group to filter by.

## Response `200`

Successful Response

- APIResponseGetSmartGroupsResponse
  - `requestId` string
  - `data` GetSmartGroupsResponse, required
    - `groups` SmartGroup[], required — The smart groups
      - `id` integer, required — The unique identifier of the smart group
      - `name` string, required — The name of the smart group
      - `description` string — The description of the smart group
      - `groupSegmentId` integer, required — The ID of the group segment this smart group belongs to
      - `numberOfUsers` integer, required — The total number of users in the group (excluding admins)
      - `isAutomaticallyCreated` boolean — Whether this smart group is automatically created and system-managed: generated from a dropdown custom field that has its 'create a group per option' setting turned on. Automatically created groups cannot be edited or deleted directly — their name and membership are owned by the field and its options. Change them by editing the source custom field instead.
      - `adminUserIds` integer[] — User IDs of admins who can administer this group — every active owner plus every manager with an explicit per-cohort authorization. Populated only when the request includes the internal include_admin_user_ids flag; otherwise null.

## Other responses

- `422` — Validation Error

---

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