Get 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

FieldTypeRequiredDescription and constraints
invitation_idstringYesInvitation ID. Format: uuid.
project_referencestringNoProject 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.

json
{
  "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.

FieldTypeRequiredDescription and constraints
idstringYesInvitation ID.
project_idstringYesID of the project the invitation is for. Format: uuid.
emailstringYesEmail address the invitation was sent to.
rolestringYesRole the invitation grants: admin, editor or viewer. Values: "admin", "editor", "viewer".
created_atstring or nullYesWhen the invitation was created (RFC 3339), or null if not recorded.

Full schemas

json
{
  "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
{
  "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#"
}