Skip to main content

settingsByKey

Overview​

Retrieves a single setting value by key, supporting dot notation for accessing nested properties in JSON objects.

Access Methods​

**Standard key**: Returns the complete setting value as-is.

**Dot notation**: Access nested properties directly using dot-separated paths (e.g., webhook_config.enabled or api_settings.credentials.token). This provides performance optimization by avoiding full object retrieval.

Behavior​

  • Dot notation is read-only. Use SaveEntitySettings mutation with the full key and value to modify settings.
  • Returns null if the key or nested path does not exist.
  • No error is raised for missing keys; use null to detect absence.

Permissions​

Requires settings:read_* permission for the entity type.

settingsByKey(
  entityId: ID!
  entityType: SettingsEntityTypeEnum!
  key: String!
): SettingsKeyValue!

Arguments​

settingsByKey.entityId ● ID! non-null scalar​

UUID of the entity instance

settingsByKey.entityType ● SettingsEntityTypeEnum! non-null enum​

Type of entity to retrieve settings for

settingsByKey.key ● String! non-null scalar​

Setting key or dot notation path (e.g., 'config' or 'config.enabled')

Type​

SettingsKeyValue object​

Represents a key-value pair for settings of an entity. This type is used to return settings in a structured format, where the key is a string and the value is a JSON object.