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

Lists recipients.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients`
- **Scope** `notify:read`
- **Effect** `read` — nothing is written.
- **Collection** [recipients](/docs/api/recipients)
- **Query** `page_size`, `page_token`, `filter`, `order_by`
- **Pagination** the answer carries `recipients` 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 |
| --- | --- | --- |
| `recipients` | `Recipient[]` | The page. |
| `next_page_token` | `string` | The token of the next page; empty on the last page. |

### Recipient

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}`. |
| `uid` | `string` | `rcp_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `external_key` | `string` | The customer's own id for this user, for example an Auth end user name. |
| `email_addresses` | `string[]` | Email addresses, first is preferred. |
| `phone_numbers` | `string[]` | E.164 phone numbers, first is preferred. |
| `devices` | `PushDevice[]` | Push devices. |
| `language_code` | `string` | BCP 47 language for templates; default the environment's. |
| `time_zone` | `string` | IANA time zone for quiet hours and digests. |
| `test` | `bool` | A test recipient: its messages are rendered and captured on the Message, never delivered. An email address whose local part carries `+sylphx_test` is a test address whatever this says. |

### 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. |

### PushDevice

| Field | Type | What it is |
| --- | --- | --- |
| `platform` | `PushPlatform` | The platform. Required. One of `apns`, `fcm`, `web_push`. |
| `device_token` | `string` | The device token; write-only. Required. Never returned again. |
| `token_last4` | `string` | The last four characters of the token, for display. Output only. |
| `sender` | `string` | The push Sender the token belongs to. Required. |

## 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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

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

**Rust**

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

**CLI**

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

**MCP**

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