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

# Get invitation

> Return an invitation.

`veryfront__get_project_invitation`

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 |
| - | - | - | - |
| `invitation_id` | `string` | Yes | Invitation ID. Format: `uuid`. |
| `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__get_project_invitation",
    "arguments": {
      "invitation_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}
```

## 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 |
| - | - | - | - |
| `id` | `string` | Yes | Invitation ID. |
| `project_id` | `string` | Yes | ID of the project the invitation is for. Format: `uuid`. |
| `email` | `string` | Yes | Email address the invitation was sent to. |
| `role` | `string` | Yes | Role the invitation grants: admin, editor or viewer. Values: `"admin"`, `"editor"`, `"viewer"`. |
| `created_at` | `string or null` | Yes | When the invitation was created (RFC 3339), or null if not recorded. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "invitation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Invitation ID."
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug."
    }
  },
  "required": [
    "invitation_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_project_invitation tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "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": "Structured result returned by the get_project_invitation 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__get_project_invitation` 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.