Preference Topics

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}

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/preferences/sections/:section_id/get.ts
A function with typed inputs. Its response is checked against the schema.

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.

Jul 29, 2026f76bed79a913 Revision changes
- info
  api tag Preference Topics added
- info
  api tag Workspace Preferences removed
Jul 9, 202649e3cc128b6c Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status