---
title: "Get flag by ID"
method: POST
path: "/flags/getById"
tags: ["Flags"]
---

# Get flag by ID

`POST /flags/getById`

## Request

- Base URL: `https://api.databuddy.cc`
- URL: `https://api.databuddy.cc/flags/getById`
- Auth: API key in header `x-api-key`

Returns a single flag by id. Requires scope read permission.

## Request body

- object
  - `id` string, required
  - `websiteId` string
  - `organizationId` string

## Response `200`

OK

- object
  - `createdAt` string, date-time, required
  - `createdBy` string, nullable, required
  - `defaultValue` boolean, required
  - `deletedAt` string, date-time, nullable, required
  - `dependencies` string[], nullable, required
  - `description` string, nullable, required
  - `environment` string, nullable, required
  - `id` string, required
  - `key` string, required
  - `name` string, nullable, required
  - `organizationId` string, nullable, required
  - `payload` object, nullable, required
  - `persistAcrossAuth` boolean, required
  - `rolloutBy` string, nullable, required
  - `rolloutPercentage` number, nullable, required
  - `status` 'active' | 'inactive' | 'archived', required
  - `targetGroupIds` string[], nullable, required
  - `targetGroups` object[]
    - `color` string, required
    - `createdAt` string, date-time, required
    - `createdBy` string, nullable, required
    - `deletedAt` string, date-time, nullable, required
    - `description` string, nullable, required
    - `id` string, required
    - `name` string, required
    - `updatedAt` string, date-time, required
    - `websiteId` string, required
  - `type` 'boolean' | 'rollout' | 'multivariant', required
  - `updatedAt` string, date-time, required
  - `userId` string, nullable, required
  - `variants` object[], nullable, required
    - `key` string, required
    - `value` unknown
    - `weight` number
    - `description` string
    - `type` 'string' | 'number' | 'json', required
  - `websiteId` string, nullable, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500
- `503`: 503

---

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