Skip to main content
GET
/
preferences
/
sections
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 workspacePreferenceListResponse = await client.workspacePreferences.list();

console.log(workspacePreferenceListResponse.results);
{
  "results": [
    {
      "id": "PS5QM06WED9YYP8H8DBVT5CXFRGE",
      "name": "Account Notifications",
      "routing_options": [
        "direct_message"
      ],
      "has_custom_routing": true,
      "created": "2024-01-15T10:30:00.000Z",
      "creator": "user_123",
      "updated": "2024-01-15T10:30:00.000Z",
      "updater": "user_123",
      "topics": [
        {
          "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.

Response

200 - application/json

The workspace's preferences, each with its topics.

results
WorkspacePreferenceGetResponse · object[]
required