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

# List flags

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

## Request

- Base URL: `https://api.vercel.com`
- URL: `https://api.vercel.com/v1/projects/{projectIdOrName}/feature-flags/flags`
- Auth: HTTP bearer

Retrieve feature flags for a project. The list can be filtered by state and supports pagination.

## Path parameters

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

## Query parameters

- `state` 'active' | 'archived': The state of the flags to retrieve. Defaults to `active`.
- `withMetadata` boolean: Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release. Use `GET /v1/projects/:id/feature-flags/flags/:flagIdOrSlug?withMetadata=true` for single-flag lookups that need creator metadata.
- `limit` integer: Maximum number of flags to return. When not set, all flags are returned.
- `cursor` string: Pagination cursor to continue from.
- `search` string: Search flags by their slug or description. Case-insensitive.
- `tags` string[]: Filter flags by tag. Repeat the parameter for multiple tags (all must match).
- `teamId` string
- `slug` string

## Response `200`

- object
  - `data` Flag[], required
    - `createdAt` number, required
    - `createdBy` string, required
    - `description` string
    - `environments` object, required
    - `id` string, required
    - `kind` 'boolean' | 'json' | 'number' | 'string', required
    - `maintainerIds` string[]
    - `ownerId` string, required
    - `permanent` false | true
    - `projectId` string, required
    - `revision` number, required
    - `seed` number, required
    - `seenInProduction` false | true
    - `slug` string, required
    - `state` 'active' | 'archived', required
    - `tags` string[]
    - `typeName` 'flag', required
    - `updatedAt` number, required
    - `updatedBy` string
    - `variants` object[], required
      - `description` string
      - `id` string, required
      - `label` string
      - `value` union, required
        - string
        - number
        - object
        - unknown[]
          - unknown
        - false | true
    - `metadata` object
      - `creator` object
        - `id` string, required
        - `name` string, required
  - `pagination` object, required
    - `next` string, nullable, 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`

## Changes

- **2026-10-15** `8939e3983223`: 1 info
  - added the optional property `data/items/seenInProduction` to the response with the `200` status
- **2026-09-30** `099fbe1f521c`: 2 info
  - added the optional property `data/items/environments/additionalProperties/fallthrough/oneOf[subschema #3]/finalPromille` to the response with the `200` status
  - added the optional property `data/items/environments/additionalProperties/rules/items/outcome/oneOf[subschema #3]/finalPromille` to the response with the `200` status
- **2026-09-15** `bc022fa59ffb`: 4 info
  - added the optional property `data/items/variants/items/description` to the response with the `200` status
  - added the optional property `data/items/variants/items/label` to the response with the `200` status
  - added the required property `data/items/variants/items/id` to the response with the `200` status
  - added the required property `data/items/variants/items/value` to the response with the `200` status
- **2026-08-22** `3157f7f3ef33`: 2 breaking
  - added `subschema #4` to the `data/items/environments/additionalProperties/fallthrough` response property `oneOf` list for the response status `200`
  - added `subschema #4` to the `data/items/environments/additionalProperties/rules/items/outcome` response property `oneOf` list for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v1/projects/:projectIdOrName/feature-flags/flags/get.md)

---

[API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)