---
title: "Read Gate"
method: GET
path: "/console/v1/gates/{id}"
tags: ["Gates"]
---

# Read Gate

`GET /console/v1/gates/{id}`

## Path parameters

- `id` string, required

## Query parameters

- `includeArchiveMetadata` 'true' | 'false'

## Response `200`

Get gate response

- object
  - `message` string, required — A simple string explaining the result of the operation.
  - `data` object, required — A single result.
    - `id` string, required — ID
    - `name` string — The gate display name
    - `idType` string
    - `description` string, required
    - `lastModifierID` string, nullable, required — ID of the last modifier.
    - `lastModifiedTime` number, double, nullable, required — Time of the last modification.
    - `lastModifierEmail` string, nullable, required — Email of the last modifier.
    - `lastModifierName` string, nullable, required — Name of the last modifier.
    - `creatorID` string, nullable
    - `createdTime` number, double, required — Timestamp when the entity was created.
    - `creatorName` string, nullable, required — Name of the creator.
    - `creatorEmail` string, nullable
    - `tags` string[]
    - `targetApps` union
      - string
      - string[]
    - `holdoutIDs` string[] — Holdouts applied to this configuration.
    - `team` string, nullable
    - `teamID` string, nullable
    - `version` number, double — Version number
    - `checksPerHour` number, double, nullable, required
    - `status` 'In Progress' | 'Launched' | 'Disabled' | 'Archived', required
    - `type` 'TEMPORARY' | 'PERMANENT' | 'STALE' | 'TEMPLATE', required
    - `typeReason` 'NONE' | 'STALE_PROBABLY_LAUNCHED' | 'STALE_PROBABLY_UNLAUNCHED' | 'STALE_PROBABLY_FORGOTTEN' | 'STALE_NO_RULES' | 'STALE_PROBABLY_DEAD_CHECK' | 'STALE_EMPTY_CHECKS' | 'STALE_ALL_TRUE' | 'STALE_ALL_FALSE', required
    - `owner` object, nullable — Schema for owner data including ID, type, name.
      - `ownerID` string — ID of the owner
      - `ownerType` string — Type of the owner (e.g., SDK_KEY or USER)
      - `ownerName` string — The name of the owner. This field is optional.
      - `ownerEmail` string — The email of the owner. This field is optional.
    - `isTemplate` boolean
    - `store0100Exposures` boolean — Whether this gate stores 0/100 exposures for monitoring/analysis.
    - `permalink` string, uri, required — A permalink to this gate in the Statsig Console.
    - `archivedAt` number, double, nullable — Timestamp (ms) of the most recent archive event when the gate is currently archived; null otherwise. May be null for gates archived before audit logging existed.
    - `archivedByID` string, nullable — ID of the user who archived this gate, when known and the gate is currently archived; null otherwise (e.g. automated archives have no user).
    - `archivedByName` string, nullable — Name of the user who archived this gate, when known and the gate is currently archived; null otherwise.
    - `archivedByEmail` string, nullable — Email of the user who archived this gate, when known and the gate is currently archived; null otherwise.
    - `archiveReason` string, nullable — Free-text reason supplied when the gate was most recently archived; null when the gate is not currently archived or no reason was given.
    - `isEnabled` boolean, required
    - `rules` object[], required
      - `name` string, required — The name of this rule.
      - `passPercentage` number, required — Of the users that meet the conditions of this rule, what percent should return true.
      - `conditions` object[], required — An array of Condition objects.
        - `targetValue` union
          - string[]
          - number[]
          - string
          - number
        - `operator` string
        - `field` string, nullable
        - `customID` string, nullable
        - `type` 'app_version' | 'browser_name' | 'browser_version' | 'country' | 'custom_field' | 'email' | 'environment_tier' | 'fails_gate' | 'fails_segment' | 'ip_address' | 'locale' | 'os_name' | 'os_version' | 'passes_gate' | 'passes_segment' | 'public' | 'time' | 'unit_id' | 'user_id' | 'user_agent' | 'url' | 'javascript' | 'device_model' | 'target_app' | 'experiment_group', required
      - `environments` string[], nullable — The environments this rule is enabled for.
      - `id` string — The Statsig ID of this rule.
      - `baseID` string — The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout
      - `returnValue` object — The return value of the rule.
      - `completedAutomatedRollouts` object[] — Read-only: Automated rollout phases that have already completed.
        - `time` number
        - `passPercent` number, required
      - `pendingAutomatedRollouts` object[] — Read-only: Automated rollout phases that are scheduled but not yet complete.
        - `time` number
        - `passPercent` number, required
    - `measureMetricLifts` boolean
    - `monitoringMetrics` object[]
      - `name` string, required
      - `type` string, required
    - `reviewSettings` object
      - `requiredReview` boolean, required
      - `allowedReviewers` object[], nullable
        - `id` string, required
        - `name` string, required
        - `email` string, required
    - `releasePipelineID` string, nullable
    - `activeReview` object
      - `reviewID` string, required
      - `reviewStatus` string, required
      - `description` string, required

---

[API](https://skmtc.net/statsig/apis/console-api.md) · [All operations](https://skmtc.net/statsig/apis/console-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/statsig/console-api/versions/3189f450c93b/schema)