---
title: get-a-segment
product: vercel
url: /docs/rest-api/feature-flags/get-a-segment
canonical_url: "https://vercel.com/docs/rest-api/feature-flags/get-a-segment"
last_updated: 2026-09-14
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about get-a-segment on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Get a segment

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

Retrieve a feature flag segment by ID or slug.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectIdOrName` | string | Yes | The project id or name |
| `segmentIdOrSlug` | string | Yes | The segment slug |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `withMetadata` | boolean. default: false | No | Whether to include metadata |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/segments/segmentIdOrSlug?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);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/segments/segmentIdOrSlug?withMetadata=true&teamId=string&slug=string', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X GET 'https://api.vercel.com/v1/projects/projectIdOrName/feature-flags/segments/segmentIdOrSlug?withMetadata=true&teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

## Example response

```json
{
  "description": "string",
  "createdBy": "string",
  "usedByFlags": [],
  "usedBySegments": [],
  "data": {
    "rules": [
      {
        "id": "icfg_1234567890",
        "outcome": {},
        "conditions": [
          {}
        ]
      }
    ],
    "include": "value",
    "exclude": "value"
  },
  "id": "icfg_1234567890",
  "label": "string",
  "slug": "string",
  "createdAt": "123",
  "updatedAt": "123",
  "projectId": "example_id",
  "typeName": "segment",
  "hint": "string",
  "metadata": {
    "creator": {
      "id": "icfg_1234567890",
      "name": "Example Name"
    }
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "createdAt",
    "data",
    "hint",
    "id",
    "label",
    "projectId",
    "slug",
    "typeName",
    "updatedAt"
  ],
  "properties": {
    "description": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "usedByFlags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "usedBySegments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "conditions",
              "id",
              "outcome"
            ]
          }
        },
        "include": {
          "type": "object",
          "additionalProperties": {
            "type": "object"
          }
        },
        "exclude": {
          "type": "object",
          "additionalProperties": {
            "type": "object"
          }
        }
      }
    },
    "id": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "createdAt": {
      "type": "number"
    },
    "updatedAt": {
      "type": "number"
    },
    "projectId": {
      "type": "string"
    },
    "typeName": {
      "type": "string",
      "enum": [
        "segment"
      ]
    },
    "hint": {
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "creator": {
          "type": "object",
          "required": [
            "id",
            "name"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### 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: No description

### 410: No description

---

## Related

- [feature-flags endpoints](/docs/rest-api#feature-flags)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)