List invitations across projects

veryfront__list_invitations

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
limitintegerNoMaximum invitations per page. Integer from 1 to 100; defaults to 20. Default: 20. Minimum: 1. Maximum: 100.
cursorstringNoOpaque page_info.next from the previous page. A cursor this list did not issue fails with invalid_input. Minimum length: 1.
sort_bystringNoSort field: created_at (default; missing values last) or email. Ties break by id ascending. Values: "created_at", "email".
sort_orderstringNoasc or desc (default). Values: "asc", "desc".

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__list_invitations",
    "arguments": {}
  }
}

Result

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

FieldTypeRequiredDescription and constraints
dataobject[]YesPending invitations across projects the caller owns, with the owning project attached to each invitation. Invitations for people who are already members are excluded.
page_infoobjectYesPagination cursor values for traversing the result set.

Full schemas

json
{
  "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."
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at",
        "email"
      ],
      "description": "Sort field: created_at (default; missing values last) or email. Ties break by id ascending."
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "asc or desc (default)."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_invitations tool."
}
json
{
  "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."
          },
          "project": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "Project ID; always equals project_id."
              },
              "slug": {
                "type": "string",
                "description": "Project slug."
              },
              "name": {
                "type": "string",
                "description": "Project name."
              }
            },
            "required": [
              "id",
              "slug",
              "name"
            ],
            "additionalProperties": false,
            "description": "The project the invitation is for."
          }
        },
        "required": [
          "id",
          "project_id",
          "email",
          "role",
          "created_at",
          "project"
        ],
        "additionalProperties": false,
        "description": "One data item returned by the tool."
      },
      "description": "Pending invitations across projects the caller owns, with the owning project attached to each invitation. Invitations for people who are already members are excluded."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null",
          "description": "The first returned by the tool."
        },
        "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,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the list_invitations tool."
}