List preferences
/v1/preferencesfor await (const preference of bird.preferences.list({ channel: "sms" })) {
console.log(preference.handle, preference.status);
}for preference in client.preferences.list(channel="email"):
print(preference.id, preference.handle, preference.status)for pref, err := range client.Preferences.List(context.Background(), bird.PreferencesListParams{
Channel: bird.PreferenceChannelSms,
Handle: "+15550001234",
}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(pref.Id, *pref.Status)
}foreach ($bird->preferences->list(['channel' => 'sms', 'handle' => '+15550001234']) as $preference) {
echo $preference->getStatus(), ' ', $preference->getCoverage(), PHP_EOL;
}bird preferences listcurl -X GET "https://us1.platform.bird.com/v1/preferences" \
-H "Authorization: Bearer $TOKEN" \
--url-query "handle=+15550001234" \
--url-query "limit=25"{
"data": [
{
"id": "prf_01krdgeqcxet5s7t44vh8rt9mg",
"channel": "sms",
"handle": "+15550001234",
"sender_scope": "+15557654321",
"topic_id": null,
"status": "revoked",
"coverage": "non_transactional",
"origin": "api_key",
"source": "signup-form-v2",
"contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the workspace's recorded preferences, most recently created first. Pass channel to narrow to one channel, and handle with it to look up everything on record for one address or number.
Each row is a key's current statement. A person can hold several rows on one channel (a channel-wide opt-out next to sender-scoped ones), and the most restrictive statement is what decides whether a message goes out.
Parâmetros de consulta
channelstringReturn only preferences on this channel.
Possible values (may grow over time): email, sms, whatsapp, amb
handlestringReturn only preferences for this exact handle: an email address or an E.164 phone number. Requires channel, since a handle only means something on its channel.
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
Payload de resposta
dataPage of preferences, most recently created first.
Mostrar atributos secundários
data.iddata.channeldata.handleWho the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.
data.sender_scopeThe sender the statement is limited to, or null when it covers the whole channel. On SMS this is the originator the person replied to; on WhatsApp it identifies the business account that messaged them; on Apple Messages for Business it is the Apple business ID used for invitations. Email preferences are always channel-wide, so it is always null there.
data.topic_idThe topic the statement is limited to, or null when it covers every topic. Part of the key that identifies a statement, alongside sender_scope.
data.statusdata.coveragedata.effective_atWhen the statement was made, as reported by whoever made it. This is what orders one key's statements: a write dated before this moment is refused rather than applied.
data.origindata.sourceFree-form note on where the statement came from, as supplied when it was recorded: a form name, an import batch, a campaign. Null when none was given.
data.consented_atWhen the person consented, as evidenced by whoever asserted the grant. Null on statements that carry no consent evidence, including every opt-out.
data.contact_idThe contact whose handle matched when the statement was recorded. Null when no contact matched at that moment; it is not updated when contacts change later.
data.created_atdata.updated_atnext_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Recursos relacionados
Continue com a documentação, guias e exemplos sobre este tópico.