Shipeasy
Flags experimentsApiOperations

List i18n keys

List keys for a profile, optionally filtered to a name prefix.

List keys for a profile, optionally filtered to a name prefix.

Use case

Read the current keys (and values) for a profile — e.g. to diff before a push.

GET
/api/admin/i18n/keys

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

Query Parameters

profile_id?string

Profile id to list keys for.

prefix?string

Only keys whose name starts with this.

q?string

Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy.

Lengthlength <= 100
limit?integer

Max keys to return (1–500).

Range1 <= value <= 500
offset?integer

Number of keys to skip before returning limit rows (offset pagination).

Default0
Range0 <= value

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/i18n/keys"
{
  "keys": [
    {
      "id": "key_01j7",
      "key": "checkout.cta",
      "value": "Buy now"
    }
  ]
}
{
  "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?
✎ Edit this page