List setting definition rows

Settings module

GET/setting-definitionssettingDefinitions.list

A setting generated from `settings.yaml`. Returns a cursor page of setting definition rows the caller may see. The default order is `setting_key` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability org.settings.read.
OAuth scopes: org.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

settingDefinitions.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of SettingDefinition

settingDefinitions.list: SettingDefinition
Field	Type	Required	Description
setting_key	string	Yes	Setting key.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
scope	SettingScope	Yes	Scope a setting value applies to, most specific first (Section 4.5.6).Constraints: one of "Personal", "Project", "Team", "Workspace", "Organization", "Platform"
value_type	string	Yes	Value type.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
edit_capability	string	Yes	Capability that edits it.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
overridable	boolean	Yes	Whether a lower scope may override it.

{
  "data": [
    {
      "setting_key": "finance.base_currency",
      "scope": "Organization",
      "value_type": "string",
      "edit_capability": "settings.finance.write",
      "overridable": true
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/setting-definitions" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.settingDefinitions.listAll()) {
  console.log(row);
}

for row in xos.setting_definitions.list_all():
    print(row)

xos setting-definitions list --all