Get user subscription topic

Returns a user's opt-in status and channel choices for one subscription topic, or the effective default if they have set no override.

get/users/{user_id}/preferences/{topic_id}

Request

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

user_idstring required

A unique identifier associated with the user whose preferences you wish to retrieve.

topic_idstring required

A unique identifier associated with a subscription topic.

tenant_idstring nullable

Query the preferences of a user for this specific tenant context.

Jul 29, 2026f76bed79a913 Revision changes
- breaking
  the / response's property type changed from string to no type for status
- breaking
  the / response's property type changed from string to no type for status
- info
  added to the / response property allOf list for the response status
- info
  added to the / response property allOf list for the response status
- info
  removed the OPTED_IN enum value from the / response property for the response status
- info
  removed the OPTED_IN enum value from the / response property for the response status
- info
  removed the OPTED_OUT enum value from the / response property for the response status
- info
  removed the OPTED_OUT enum value from the / response property for the response status
- info
  removed the REQUIRED enum value from the / response property for the response status
- info
  removed the REQUIRED enum value from the / response property for the response status
Oct 17, 2025e67d02739533 Revision changes
- info
  api tag User Preferences added
- info
  api tag UsersPreferences removed