Retrieves a Catalog Field

Retrieves a specific Catalog Field by id

GET /v1/catalog_fields/{id}

Retrieves a Catalog Field

cURL

curl --request GET \
  --url https://api.rootly.com/v1/catalog_fields/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "<string>",
    "type": "catalog_fields",
    "attributes": {
      "catalog_id": "<string>",
      "name": "<string>",
      "kind": "text",
      "multiple": true,
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "slug": "<string>",
      "kind_catalog_id": "<string>",
      "required": true,
      "catalog_type": "catalog"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> string · required

Resource UUID

Query Parameters

include · enum<string>

comma separated if needed. eg: catalog

Available options: catalog

Response

200

application/vnd.api+json

catalog_field found without catalog_type when feature disabled

data · object · required

Show child attributes