Get a notification preference
Platform module
GET/notification-preferences/{id}notificationPreferences.get
A per-kind, per-channel notification preference. Returns one notification preference with its `ETag`. A notification preference the caller may not see returns 404.
- Requires the capability me.notifications.write.
- OAuth scopes: me.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the notification preference. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: NotificationPreference
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the notification preference. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| channel | "In App" | "Email" | "SMS" | "Push" | Yes | Delivery channel. |
| enabled | boolean | Yes | Whether the channel is on for the kind. |
| membership_id | string (uuid) | Yes | Identifier of the membership whose preference this is; preferences are per org. |
| category_code | string | Yes | Notification category.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"channel": "In App",
"enabled": true,
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"category_code": "approvals"
}Code samples
curl -X GET "$XOS_BASE_URL/notification-preferences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.notificationPreferences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.notification_preferences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos notification-preferences get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f