---
title: "Read Rule Vocabulary"
method: GET
path: "/admin/notifications/rules/vocabulary"
tags: ["admin", "notification-rules"]
---

# Read Rule Vocabulary

`GET /admin/notifications/rules/vocabulary`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/notifications/rules/vocabulary`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- RuleVocabularyResponse: Everything an authoring client needs to offer a rule, derived rather than listed. ``attributes`` and ``derived`` come straight out of the library: the registry builds its catalog from the Pydantic models, so labels, enum members and the operators each type accepts all follow from the declaration. A new attribute appears here the moment it is declared, with no change to this module and no release on either side.
  - `attributes` CatalogEntry[], required
    - `key` string, required
    - `source` string, required
    - `type` string, required
    - `label` string, required
    - `enum_values` string[], nullable
    - `open_names` boolean
    - `operators` string[]
  - `derived` FunctionEntry[], required
    - `function_name` string, required
    - `args_schema` object, required
    - `backends` Backend[], required
  - `derived_values` RuleDerivedValues[], required
    - `name` string, required
    - `values` string[], required
  - `event_types` string[], required
  - `previewable_event_types` string[], required
  - `dispatched_event_types` string[], required
  - `send_time_attributes` object, required
  - `presence_only_attributes` string[], required
  - `follow_up_attributes` string[], required
  - `event_type_labels` object, required
  - `outputs` string[], required
  - `channels` string[], required
  - `authorable_channels` string[], required
  - `default_channels` string[], required
  - `event_timings` object
  - `recipient_kinds` string[], required
  - `sms_incapable_recipient_kinds` string[], required
  - `call_incapable_recipient_kinds` string[], required
  - `call_incapable_rotation_sources` string[], required
  - `timings` string[], required
  - `escalation_delay_presets` integer[], required
  - `max_escalation_delay_minutes` integer, required
  - `escalation_event_types` string[], required
  - `escalation_step_channels` string[], required
  - `escalation_step_capable_channels` string[], required
  - `block_reasons` string[], required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)