Listar preferências de notificação
RegistosGET /notification-preferences
Returns the recorded communication preferences of the tenant's recipients: consent status, preferred locale, per-event and per-channel choices, quiet hours and time zone. The optional recipient_type and recipient_id query values narrow the list, and results use cursor pagination. Requires the notifications:read permission.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Devolve
200 Utility-scoped, channel-neutral preferences
Mostrar atributos
dataMostrar atributos filhos
idrecipient_typerecipient_idconsent_statusum de
granted,withdrawn,required_notice_onlypreferred_localeum de
pt-MZ,en-USeventschannelsquiet_hours_startquiet_hours_endtimezoneIANA time zone for the recipient's quiet hours
has_morenext_cursor
Permissões notifications:read · Funções: admin, customer_service, owner
curl -X GET "$BUSINESS_API/notification-preferences" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/notification-preferences", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/notification-preferences",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/notification-preferences", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "not_25JciZ96OjFmw7Nk8jrG0JbC4zp",
"recipient_type": "recipient type",
"recipient_id": "rec_2Fj2I5VC2F9MUXfa4XBWM39egPf",
"consent_status": "granted",
"preferred_locale": "pt-MZ",
"events": {
"key": true
},
"channels": {
"key": true
},
"quiet_hours_start": "quiet hours start",
"quiet_hours_end": "quiet hours end",
"timezone": "Africa/Maputo"
}
],
"has_more": true,
"next_cursor": "next cursor"
}