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

Lists invitations.

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

### Invitation

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/customer_organizations/{customer_organization}/invitations/{invitation}`. |
| `uid` | `string` | `inv_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `email` | `string` | The invited address. Required. |
| `roles` | `string[]` | Roles the membership gets; empty means the environment's default roles. |
| `state` | `InvitationState` | The lifecycle state. Output only. One of `pending`, `accepted`, `revoked`, `expired`. |
| `expire_time` | `timestamp` | When it expires. Output only. |
| `accept_time` | `timestamp` | When it was accepted. Output only. |
| `end_user` | `string` | The end user who accepted it. Output only. |
| `membership` | `string` | The membership accepting it created. Output only. |
| `ttl` | `duration` | How long it stays open; default 7 days, at most 30. |

### 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/customer_organizations/customer-organization/invitations" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.auth.invitations.list({ parent: 'orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization' })
```

**Rust**

```rust
let mut req = sylphx::auth::ListInvitationsRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization".to_string();
let response = sx.auth().invitations().list(req).await?;
```

**CLI**

```bash
sylphx auth invitations list orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization
```

**MCP**

```json
{ "method_id": "auth.invitations.list", "args": {"parent":"orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization"} }
```