Get a catalog entity by ref

Looks an entity up by its ref instead of its ID. A ref is {kind}://{namespace}/{name}, or {kind}://{name} for an entity without a namespace, where each part is a lowercase slug.

get/api/rest/v1/catalog/by-ref

Request

Base URL: https://app.componecat.ai
URL: https://app.componecat.ai/api/rest/v1/catalog/by-ref
Auth: none required

Query parameters

refstring

The entity ref, e.g. component://payments/payment-gateway.

Response

Example response

{
  "data": {
    "fields": {
      "costCenter": "CC-100",
      "tier": 1,
      "isPublic": true,
      "environments": [
        "prod",
        "staging"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.