---
title: "Get a flag"
method: GET
path: "/v1/projects/{projectIdOrName}/feature-flags/flags/{flagIdOrSlug}"
tags: ["feature-flags"]
---

# Get a flag

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

Retrieve a specific feature flag by its ID or slug.

## Path parameters

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

## Query parameters

- `ifMatch` string — Etag to match, can be used interchangeably with the `if-match` header
- `withMetadata` boolean — Whether to include metadata in the response
- `teamId` string
- `slug` string

## Response `200`

- Flag
  - `description` string
  - `maintainerIds` string[]
  - `permanent` false | true
  - `tags` string[]
  - `experiment` object
    - `id` string
    - `name` string
    - `numVariants` number
    - `surfaceArea` string
    - `stickyRequirement` false | true
    - `layer` string
    - `guardrailMetrics` object[]
      - `description` string
      - `metricFormula` string
      - `name` string, required
      - `metricType` 'count' | 'currency' | 'percentage', required
      - `metricUnit` 'session' | 'user' | 'visitor', required
      - `directionality` 'decreaseIsGood' | 'increaseIsGood', required
    - `hypothesis` string
    - `device` 'android' | 'desktop' | 'ios' | 'mweb'
    - `controlVariantId` string
    - `startedAt` number
    - `endedAt` number
    - `decision` string
    - `decisionReason` string
    - `duration` number
    - `durationUnit` 'days' | 'exposures'
    - `allocationPercent` number
    - `allocationUnit` 'cookieId' | 'userId' | 'visitorId', required
    - `primaryMetrics` object[], required
      - `description` string
      - `metricFormula` string
      - `name` string, required
      - `metricType` 'count' | 'currency' | 'percentage', required
      - `metricUnit` 'session' | 'user' | 'visitor', required
      - `directionality` 'decreaseIsGood' | 'increaseIsGood', required
    - `status` 'closed' | 'draft' | 'paused' | 'running', required
  - `updatedBy` string
  - `variants` object[], required
  - `id` string, required
  - `environments` object, required
  - `kind` 'boolean' | 'json' | 'number' | 'string', required
  - `revision` number, required
  - `seed` number, required
  - `state` 'active' | 'archived', required
  - `slug` string, required
  - `createdAt` number, required
  - `updatedAt` number, required
  - `createdBy` string, required
  - `ownerId` string, required
  - `projectId` string, required
  - `typeName` 'flag', required
  - `metadata` object
    - `creator` object
      - `id` string, required
      - `name` string, required

## Other responses

- `304`
- `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/61d1ba3f6dac/schema)