Skip to main content
GET
/
preferences
/
sections
/
{section_id}
/
topics
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const workspacePreferenceTopicListResponse = await client.workspacePreferences.topics.list(
  'section_id',
);

console.log(workspacePreferenceTopicListResponse.results);
{
  "results": [
    {
      "id": "PT91W47CKEMP6PW0RYVN3F08F2YE",
      "name": "Product Updates",
      "default_status": "OPTED_OUT",
      "routing_options": [
        "direct_message"
      ],
      "allowed_preferences": [
        "snooze"
      ],
      "include_unsubscribe_header": true,
      "topic_data": {},
      "created": "2024-01-15T10:30:00.000Z",
      "creator": "user_123",
      "updated": "2024-01-15T10:30:00.000Z",
      "updater": "user_123"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

section_id
string
required

Id of the workspace preference.

Response

Topics contained in a workspace preference.

results
WorkspacePreferenceTopicGetResponse · object[]
required