# List invitations

> The invitations.list operation: GET /api/v1/invitations in the REST API and the invitations_list tool in the MCP server.

Lists the organization's invitations, newest first, with their status: `pending`, `accepted`, `revoked`
or `expired` (invitations work for 7 days). Filter with `status`, e.g. `pending` for the invitations still
waiting for an answer. Tokens are never returned. Paginate with `limit` and `starting_after`.

Needs `members:read` (organization owners and admins, or an org management key).

## At a glance

- **REST:** `GET /api/v1/invitations`
- **MCP tool:** `invitations_list`
- **Operation ID:** `invitations.list`
- **Scope:** Organization
- **Permission:** `members:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test and live
- **Pagination:** `limit` (at most 100) and `starting_after`
- **Authentication:** API key with the `members:read` scope
- **Since:** M1

## Request

### Query parameters

| Field            | Type                                               | Required | Description |
| ---------------- | -------------------------------------------------- | -------- | ----------- |
| `status`         | one of `pending`, `accepted`, `revoked`, `expired` | No       |             |
| `limit`          | integer (1 to 100)                                 | No       |             |
| `starting_after` | `invt_…` ID                                        | No       |             |

## Response

`200 OK` with a JSON object, a page of the list (newest first):

| Field               | Type                                                                                                         | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------ | ----------- |
| `object`            | `"list"`                                                                                                     |             |
| `data`              | array of object                                                                                              |             |
| `data[].id`         | `invt_…` ID                                                                                                  |             |
| `data[].object`     | `"invitation"`                                                                                               |             |
| `data[].orgId`      | `org_…` ID                                                                                                   |             |
| `data[].email`      | string                                                                                                       |             |
| `data[].role`       | one of `org_owner`, `org_admin`, `billing_admin`, `finance`, `tax_manager`, `support`, `developer`, `viewer` |             |
| `data[].scope`      | object                                                                                                       |             |
| `data[].status`     | one of `pending`, `accepted`, `revoked`, `expired`                                                           |             |
| `data[].expiresAt`  | date-time                                                                                                    |             |
| `data[].invitedBy`  | `usr_…` ID                                                                                                   |             |
| `data[].acceptedAt` | date-time or null                                                                                            |             |
| `data[].revokedAt`  | date-time or null                                                                                            |             |
| `data[].createdAt`  | date-time                                                                                                    |             |
| `has_more`          | boolean                                                                                                      |             |
| `next_cursor`       | `invt_…` ID or null                                                                                          |             |

## Examples

### Pending invitations

```http
GET /api/v1/invitations?status=pending
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "invt_01m4tx5nj8emwbyf7y9vcf47x8",
      "object": "invitation",
      "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
      "email": "finance@acme.example",
      "role": "finance",
      "scope": {
        "type": "entity",
        "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2"
      },
      "status": "pending",
      "expiresAt": "2026-10-20T12:00:00.000Z",
      "invitedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
      "acceptedAt": null,
      "revokedAt": null,
      "createdAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

### Everything, two per page

```http
GET /api/v1/invitations?limit=2
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "invt_01m4tx5nj8emwbyf7y9vcf47x8",
      "object": "invitation",
      "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
      "email": "finance@acme.example",
      "role": "finance",
      "scope": {
        "type": "entity",
        "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2"
      },
      "status": "pending",
      "expiresAt": "2026-10-20T12:00:00.000Z",
      "invitedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
      "acceptedAt": null,
      "revokedAt": null,
      "createdAt": "2026-10-13T12:00:00.000Z"
    },
    {
      "id": "invt_01m4tx5nj8emwbyf7y9vcf47x9",
      "object": "invitation",
      "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
      "email": "dev@acme.example",
      "role": "developer",
      "scope": {
        "type": "brand",
        "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4"
      },
      "status": "accepted",
      "expiresAt": "2026-10-20T12:00:00.000Z",
      "invitedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
      "acceptedAt": "2026-10-14T09:30:00.000Z",
      "revokedAt": null,
      "createdAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "invt_01m4tx5nj8emwbyf7y9vcf47x9"
}
```

## Errors

| Code                                                                                   | HTTP status | When                                       | What to do                                                                      |
| -------------------------------------------------------------------------------------- | ----------- | ------------------------------------------ | ------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed) | 400         | A filter or pagination value is malformed. | Fix the fields listed in `details.issues` and send the request again.           |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied) | 403         | You can't see this organization's members. | Ask an organization owner or admin for a role or scope that allows this action. |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found), [`dry_run_not_supported`](https://ownrecord.io/docs/reference/errors.md#dry_run_not_supported), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).