List segments | Vercel REST API

APIs & SDKs

List segments

GEThttps://api.vercel.com/v1/projects/{projectIdOrName}/feature-flags/segments

List all feature flag segments for a project.

https://api.vercel.com/v1/projects/{projectIdOrName}/feature-flags/segments

const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/segments?withMetadata=true&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "data": [
    {
      "createdAt": "123",
      "createdBy": "string",
      "data": {
        "exclude": "value",
        "include": "value",
        "rules": [
          {
            "conditions": [
              {
                "cmp": "!contains",
                "cmpOptions": {
                  "ignoreCase": "false"
                },
                "lhs": {
                  "type": "segment"
                },
                "rhs": "string"
              }
            ],
            "id": "icfg_1234567890",
            "outcome": {
              "type": "all"
            }
          }
        ]
      },
      "description": "string",
      "hint": "string",
      "id": "icfg_1234567890",
      "label": "string",
      "projectId": "example_id",
      "slug": "string",
      "typeName": "segment",
      "updatedAt": "123",
      "usedByFlags": [],
      "usedBySegments": [],
      "metadata": {
        "creator": {
          "id": "icfg_1234567890",
          "name": "Example Name"
        }
      }
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdOrNamestringRequired

The project id or name

Query parameters

withMetadatabooleanOptional

Whether to include metadata

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

dataarrayRequired

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

402The account is missing a payment so payment method must be updated

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: List segments (/docs/rest-api/feature-flags/list-segments)

From the Vercel docs graph (built 2026-10-13T05:35:52.211Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get a segment — GET /v1/projects/{projectIdOrName}/feature-flags/segments/{segmentIdOrSlug} — Retrieve a feature flag segment by ID or s
Create a segment — PUT /v1/projects/{projectIdOrName}/feature-flags/segments — Create a new feature flag segment.
Update a segment — PATCH /v1/projects/{projectIdOrName}/feature-flags/segments/{segmentIdOrSlug} — Update an existing feature flag segment.
List flag versions — GET /v1/projects/{projectIdOrName}/feature-flags/flags/{flagIdOrSlug}/versions — Lists flag versions for a given flag.
List flags — GET /v2/projects/{projectIdOrName}/feature-flags/flags — Retrieve feature flags for a project. Returns an opaque cursor

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/projects/{projectIdOrName}/feature-flags/segments

const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/segments?withMetadata=true&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "data": [
    {
      "createdAt": "123",
      "createdBy": "string",
      "data": {
        "exclude": "value",
        "include": "value",
        "rules": [
          {
            "conditions": [
              {
                "cmp": "!contains",
                "cmpOptions": {
                  "ignoreCase": "false"
                },
                "lhs": {
                  "type": "segment"
                },
                "rhs": "string"
              }
            ],
            "id": "icfg_1234567890",
            "outcome": {
              "type": "all"
            }
          }
        ]
      },
      "description": "string",
      "hint": "string",
      "id": "icfg_1234567890",
      "label": "string",
      "projectId": "example_id",
      "slug": "string",
      "typeName": "segment",
      "updatedAt": "123",
      "usedByFlags": [],
      "usedBySegments": [],
      "metadata": {
        "creator": {
          "id": "icfg_1234567890",
          "name": "Example Name"
        }
      }
    }
  ]
}

OpenAPI Specification