Shipeasy
Flags experimentsApiOperations

Get one config

Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders.

Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders.

Use case

Fetch one config's current published values and any in-flight drafts.

GET
/api/admin/configs/{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 config id (cfg_…) or the config'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/configs/string"
{
  "id": "cfg_01j7wae5h6j7k8l9m0n1p2q3r4",
  "name": "pricing.tiers",
  "description": "Pricing tier definitions consumed by the checkout flow.",
  "folder": "pricing",
  "schema": {
    "type": "object",
    "properties": {
      "tiers": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    },
    "required": [
      "tiers"
    ]
  },
  "updatedAt": "2026-05-09T18:22:11.000Z",
  "envs": {
    "dev": {
      "version": 5,
      "publishedAt": "2026-05-09T18:22:11.000Z",
      "publishedBy": "ana@example.com"
    },
    "stage": {
      "version": 4,
      "publishedAt": "2026-05-08T11:05:22.000Z",
      "publishedBy": "ana@example.com"
    },
    "prod": {
      "version": 4,
      "publishedAt": "2026-05-08T11:05:22.000Z",
      "publishedBy": "ana@example.com"
    }
  },
  "drafts": {
    "dev": {
      "updatedAt": "2026-05-10T09:31:00.000Z",
      "authorEmail": "bo@example.com",
      "baseVersion": 5
    }
  },
  "values": {
    "dev": {
      "tiers": [
        {
          "name": "free"
        },
        {
          "name": "pro"
        }
      ]
    },
    "stage": {
      "tiers": [
        {
          "name": "free"
        },
        {
          "name": "pro"
        }
      ]
    },
    "prod": {
      "tiers": [
        {
          "name": "free"
        },
        {
          "name": "pro"
        }
      ]
    }
  },
  "draftValues": {
    "dev": {
      "tiers": [
        {
          "name": "free"
        },
        {
          "name": "pro"
        },
        {
          "name": "enterprise"
        }
      ]
    }
  }
}
{
  "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