---
title: "List segments"
method: GET
path: "/v1/projects/{projectIdOrName}/feature-flags/segments"
tags: ["feature-flags"]
---

# List segments

`GET /v1/projects/{projectIdOrName}/feature-flags/segments`

List all feature flag segments for a project.

## Path parameters

- `projectIdOrName` string, required — The project id or name

## Query parameters

- `withMetadata` boolean — Whether to include metadata
- `teamId` string
- `slug` string

## Response `200`

- object
  - `data` Segment[], required
    - `description` string
    - `createdBy` string
    - `usedByFlags` string[]
    - `usedBySegments` string[]
    - `data` object, required
      - `rules` object[]
        - `id` string, required
        - `outcome` union, required
          - object
            - `type` 'all', required
          - object
            - `type` 'split', required
            - `base` object, required
              - …
            - `passPromille` number, required
        - `conditions` object[], required
          - `rhs` union
            - string
            - number
            - object
              - …
            - object
              - …
            - false | true
          - `cmpOptions` object
            - `ignoreCase` false | true
          - `lhs` union, required
            - object
              - …
            - object
              - …
          - `cmp` '!contains' | '!endsWith' | '!eq' | '!ex' | '!oneOf' | '!regex' | '!startsWith' | 'after' | 'before' | 'contains' | 'containsAllOf' | 'containsAnyOf' | 'containsNoneOf' | 'endsWith' | 'eq' | 'ex' | 'gt' | 'gte' | 'lt' | 'lte' | 'oneOf' | 'regex' | 'startsWith', required
      - `include` object
      - `exclude` object
    - `id` string, required
    - `label` string, required
    - `slug` string, required
    - `createdAt` number, required
    - `updatedAt` number, required
    - `projectId` string, required
    - `typeName` 'segment', required
    - `hint` string, required
    - `metadata` object
      - `creator` object
        - `id` string, required
        - `name` string, required

## Other responses

- `400` — One of the provided values in the request query is invalid.
- `401` — The request is not authorized.
- `402` — The account is missing a payment so payment method must be updated
- `403` — You do not have permission to access this resource.
- `404`
- `410`

---

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