---
title: "Get smart group segments"
method: GET
path: "/users/v1/smart-group-segments"
tags: ["Users:v1:Smart Group Segments"]
---

# Get smart group segments

`GET /users/v1/smart-group-segments`

Retrieves all smart group segments associated with the account. Optionally, filter the results by segment IDs and/or names.

## Query parameters

- `segmentIds` integer[] — Smart group segment IDs to filter by
- `names` string[] — Smart group segment names to filter by

## Response `200`

Successful Response

- APIResponseSmartGroupSegmentsResponse
  - `requestId` string
  - `data` SmartGroupSegmentsResponse, required
    - `segments` SmartGroupSegment[], required — List of smart group segments
      - `id` integer, required — The unique identifier of the smart group segment
      - `name` string, required — The name of the smart group segment
      - `color` string, required — The color hex code of the smart group segment
      - `sortOrder` integer, required — The sort order of the smart group segment

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