---
title: "Get Segment"
method: GET
path: "/v1/segments/{segmentId}"
tags: ["Segments"]
---

# Get Segment

`GET /v1/segments/{segmentId}`

This endpoint returns the metadata of a Segment
identified by the `segmentId`.

## Path parameters

- `segmentId` string, uuid, required

## Response `200`

When everything is ok, the config data returned.

- SegmentModel
  - `product` ProductModel, required — Details of the Product.
    - `organization` OrganizationModel, required — Details of the Organization.
      - `organizationId` string, uuid, required — Identifier of the Organization.
      - `name` string, required — Name of the Organization.
    - `productId` string, uuid, required — Identifier of the Product.
    - `name` string, required — Name of the Product.
    - `description` string, nullable, required — Description of the Product.
    - `order` integer, required — The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.
    - `reasonRequired` boolean, required — Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.
    - `approveRequired` boolean, required — Determines whether changes must be approved before they are applied within a Product.
  - `segmentId` string, uuid, required — Identifier of the Segment.
  - `name` string, required — Name of the Segment.
  - `description` string, nullable, required — Description of the Segment.
  - `creatorEmail` string, nullable, required — The email of the user who created the Segment.
  - `creatorFullName` string, nullable, required — The name of the user who created the Segment.
  - `createdAt` string, date-time, required — The date and time when the Segment was created.
  - `lastUpdaterEmail` string, nullable, required — The email of the user who last updated the Segment.
  - `lastUpdaterFullName` string, nullable, required — The name of the user who last updated the Segment.
  - `updatedAt` string, date-time, required — The date and time when the Segment was last updated.
  - `comparisonAttribute` string, required — The user's attribute the evaluation process must take into account.
  - `comparator` 'isOneOf' | 'isNotOneOf' | 'contains' | 'doesNotContain' | 'semVerIsOneOf' | 'semVerIsNotOneOf' | 'semVerLess' | 'semVerLessOrEquals' | 'semVerGreater' | 'semVerGreaterOrEquals' | 'numberEquals' | 'numberDoesNotEqual' | 'numberLess' | 'numberLessOrEquals' | 'numberGreater' | 'numberGreaterOrEquals' | 'sensitiveIsOneOf' | 'sensitiveIsNotOneOf', required — The comparison operator the evaluation process must use when it compares the given user attribute's value with the comparison value.
  - `comparisonValue` string, required — The value to compare with the given user attribute's value.

## Other responses

- `400` — Bad request.
- `404` — Not found.
- `429` — Too many requests. In case of the request rate exceeds the rate limits.

---

[API](https://skmtc.net/configcat/apis/configcat-public-management-api.md) · [All operations](https://skmtc.net/configcat/apis/configcat-public-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/configcat/configcat-public-management-api/versions/6b4d53bc1455/schema)