Get a preference section

Returns one workspace preference by id, including its subscription topics, routing options, and custom routing flag.

get/preferences/sections/{section_id}

Path parameters

section_idstring required

Id of the workspace preference.

idstring required

The workspace preference id.

namestring required

Human-readable name.

descriptionstring nullable

Optional description shown under the section on the hosted preferences page.

routing_optionsChannelClassification[] required

Default channels for the workspace preference. May be empty.

has_custom_routingboolean required

Whether the workspace preference defines custom routing for its topics.

createdstring required

ISO-8601 timestamp of when the workspace preference was created.

creatorstring nullable

Id of the creator.

updatedstring nullable

ISO-8601 timestamp of the last update.

updaterstring nullable

Id of the last updater.

Changed in 4 of the 55 revisions of this API.8

Jul 29, 2026f76bed79a9132See the full diff
- ○
  api tag Preference Topics added
  api-tag-added
- ○
  api tag Workspace Preferences removed
  api-tag-removed
Jul 9, 202649e3cc128b6c2See the full diff
- ○
  added the optional property description to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property topics/items/description to the response with the 200 status
  response-optional-property-added
Jun 26, 202661131080b1853See the full diff
- ○
  api operation id preferenceSections_retrieve removed and replaced with workspacePreferences_retrieve
  api-operation-id-removed
- ○
  api tag Workspace Preferences added
  api-tag-added
- ○
  api tag Preference Sections removed
  api-tag-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 2026124a60dd716b1See the full diff
- ○
  endpoint added
  endpoint-added