Shipeasy
APIOperations

Get one gate

Returns the full gate row — including the gatekeeper stack, resolved creator/last-editor emails, and the edit version — for one gate, addressed by id or name.

Returns the full gate row — including the gatekeeper stack, resolved creator/last-editor emails, and the edit version — for one gate, addressed by id or name.

Use case

Inspect a single gate's current rollout, rules, and stack before editing it, without paging through the whole list.

GET
/api/admin/gates/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque gate id (gat_…) or the gate's name.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/gates/string"
{
  "id": "gat_01j7w7m9q4hxbf6npe6s9zr3vc",
  "name": "checkout_v2",
  "enabled": 1,
  "type": "targeting",
  "rolloutPct": 5000,
  "rules": [
    {
      "attr": "country",
      "op": "in",
      "value": [
        "US",
        "CA",
        "GB"
      ]
    }
  ],
  "salt": "9c1f4f1f2c0c4a5fa1c2b6d3e7c8e3a1",
  "title": "Checkout v2",
  "description": "New checkout flow. Pro users in US/CA/GB only.",
  "folder": "checkout",
  "groupName": "growth",
  "ownerEmail": "ana@example.com",
  "stack": null,
  "creatorEmail": "ana@example.com",
  "updaterEmail": "bo@example.com",
  "version": 4,
  "createdAt": "2026-05-01T10:12:00.000Z",
  "updatedAt": "2026-05-09T16:01:22.000Z"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
Updated August 8, 2026