Shipeasy
Flags experimentsApiOperations

Get one gate template

Returns a single template by its id — a built-in slug (country) or a customer gtpl_… id.

Returns a single template by its id — a built-in slug (country) or a customer gtpl_… id.

GET
/api/admin/gates/templates/{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

Built-in slug (country) or customer template id (gtpl_…).

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

curl -X GET "https://shipeasy.ai/api/admin/gates/templates/string"
{
  "id": "string",
  "name": "string",
  "description": "string",
  "category": "condition",
  "auto": true,
  "builtin": true,
  "iconKey": "string",
  "rules": [
    {
      "attr": "string",
      "op": "eq",
      "value": null
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "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"
}
Was this page helpful?
✎ Edit this page