---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "List preferences"
description: "`notify.preferences.list` (GET /v1/{parent}/preferences): Lists preferences."
type: reference
product: notifications
summary: "Lists preferences."
updated: 2026-09-28
nav: false
---

Lists preferences.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences`
- **Scope** `notify:read`
- **Effect** `read` — nothing is written.
- **Collection** [preferences](/docs/api/preferences)
- **Query** `page_size`, `page_token`, `filter`, `order_by`
- **Pagination** the answer carries `preferences` and, when there is more, `next_page_token`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to list in. Required. |
| `page_size` | `int32` | At most this many; default 50, clamped to 1000. |
| `page_token` | `string` | `next_page_token` of the previous page. |
| `filter` | `string` | AIP-160 filter over labels and filterable fields. |
| `order_by` | `string` | AIP-132 ordering over filterable fields. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `preferences` | `Preference[]` | The page. |
| `next_page_token` | `string` | The token of the next page; empty on the last page. |

### Preference

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}`. |
| `uid` | `string` | `prf_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `channels` | `Channel[]` | Channels the topic may use; empty mutes the topic. One of `email`, `sms`, `push`, `inbox`. |
| `digest_interval` | `duration` | Batch this topic into a digest at most this often; unset sends each message. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.notify.preferences.list({ parent: 'orgs/acme/projects/shop/envs/production/recipients/recipient' })
```

**Rust**

```rust
let mut req = sylphx::notify::ListPreferencesRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production/recipients/recipient".to_string();
let response = sx.notify().preferences().list(req).await?;
```

**CLI**

```bash
sylphx notify preferences list orgs/acme/projects/shop/envs/production/recipients/recipient
```

**MCP**

```json
{ "method_id": "notify.preferences.list", "args": {"parent":"orgs/acme/projects/shop/envs/production/recipients/recipient"} }
```