Get a catalog item

Returns a service catalog item, including its form fields

Get a catalog item

get

Returns a catalog item with full details including form fields.

Authorizations

AuthorizationstringRequired

Harmony access key, sent as Authorization: AccessKey <your-key>. Create keys in Settings > Access Keys. The tenant is resolved from the key.

Path parameters

item_idstring · uuidRequired

Query parameters

include_deletedbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

idstring · uuidRequired

namestringRequired

iconstring · nullableRequired

descriptionstringRequired

category_idstring · uuidRequired

desk_idstringRequired

subdesk_idstring · nullableRequired

ticket_typestring · enumRequiredPossible values:

prioritystring · enumRequiredPossible values:

is_visiblebooleanRequired

is_featuredbooleanRequired

discoveredbooleanOptionalDefault: false

deleted_atstring · date-time · nullableOptional

display_orderintegerRequired

external_ref_idstring · nullableOptional

created_bystringRequired

updated_bystringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get/api/v1/items/{item_id}

GET /service-catalog/api/v1/items/{item_id} HTTP/1.1
Host: api.harmony.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "icon": "text",
  "description": "text",
  "category_id": "123e4567-e89b-12d3-a456-426614174000",
  "desk_id": "text",
  "subdesk_id": "text",
  "ticket_type": "request",
  "priority": "low",
  "is_visible": true,
  "is_featured": true,
  "discovered": false,
  "deleted_at": "2026-01-01T00:00:00.000Z",
  "display_order": 1,
  "form_fields": [
    {
      "type": "single_select",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": "text",
      "rule": {
        "action": "show",
        "logic": "all",
        "conditions": [
          {
            "field_id": "123e4567-e89b-12d3-a456-426614174000",
            "value": "text",
            "type": "single_select",
            "operator": "equals"
          }
        ]
      },
      "required": false,
      "is_filled_by_desk_member": false,
      "placeholder": "text",
      "default_value": "text",
      "description": "text",
      "previous_labels": [
        "text"
      ],
      "help_text": "text",
      "options": [
        "text"
      ]
    }
  ],
  "external_ref_id": "text",
  "external_provider_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "origin": "text",
    "is_orderable": true,
    "order_endpoint": "text",
    "unresolved_mandatory_fields": [
      "text"
    ],
    "snow_class": "text"
  },
  "created_by": "text",
  "updated_by": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}