Skip to main content

settingsByEntity

Overview​

Retrieves settings configuration and current values for an entity. Use to discover available settings and render configuration forms.

Behavior​

When filtering by key, an error is raised if no schema is defined for that key. Only settings with configured schemas can be queried individually.

Permissions​

Requires settings:read_* permission for the entity type.

settingsByEntity(
  entityId: ID!
  entityType: SettingsEntityTypeEnum!
  key: String
): SettingsByEntity!

Arguments​

settingsByEntity.entityId ● ID! non-null scalar​

UUID of the entity instance

settingsByEntity.entityType ● SettingsEntityTypeEnum! non-null enum​

Type of entity to retrieve settings for

settingsByEntity.key ● String scalar​

Optional: specific setting key to filter by. If omitted, returns all available settings

Type​

SettingsByEntity object​

Represents all available settings for a specific entity with their current values. Contains entity identification and an array of all available settings with their options.