> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List invitations

> List the invitations.

`veryfront__list_project_invitations`

Requires project.invites.read.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `limit` | `integer` | No | Maximum invitations per page. Integer from 1 to 100; defaults to 20. Default: `20`. Minimum: `1`. Maximum: `100`. |
| `cursor` | `string` | No | Opaque `page_info`.next from the previous page. A cursor this list did not issue fails with `invalid_input`. Minimum length: `1`. |
| `project_reference` | `string` | No | Project ID or slug. |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_project_invitations",
    "arguments": {}
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | Pending invitations for the project, newest first. |
| `page_info` | `object` | Yes | Pagination cursor values for traversing the result set. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum invitations per page. Integer from 1 to 100; defaults to 20.",
      "default": 20
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "description": "Opaque page_info.next from the previous page. A cursor this list did not issue fails with invalid_input."
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_project_invitations tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Invitation ID."
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the project the invitation is for."
          },
          "email": {
            "type": "string",
            "description": "Email address the invitation was sent to."
          },
          "role": {
            "type": "string",
            "enum": [
              "admin",
              "editor",
              "viewer"
            ],
            "description": "Role the invitation grants: admin, editor or viewer."
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "When the invitation was created (RFC 3339), or null if not recorded."
          }
        },
        "required": [
          "id",
          "project_id",
          "email",
          "role",
          "created_at"
        ],
        "additionalProperties": false
      },
      "description": "Pending invitations for the project, newest first."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_project_invitations tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_project_invitations` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.