List account invitations

veryfront__list_account_invitations

Requires account.invitations.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
cursorstringNoOpaque pagination cursor returned by a previous response.
limitintegerNoMaximum number of results to return. Default: 20. Minimum: 1. Maximum: 100.
statusstringNoLifecycle status for the target record. Default: "pending". Values: "pending", "accepted", "revoked", "expired", "all".
account_idstringYesProvide the account id. Format: uuid.

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_account_invitations",
    "arguments": {
      "account_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
dataobject[]YesAccount invitations, newest first, filtered by status. Pending is the default. Acceptance tokens are never included.
page_infoobjectYesPagination cursor values for traversing the result set.

Full schemas

json
{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "Opaque pagination cursor returned by a previous response."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20,
      "description": "Maximum number of results to return."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "accepted",
        "revoked",
        "expired",
        "all"
      ],
      "default": "pending",
      "description": "Lifecycle status for the target record."
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the account id."
    }
  },
  "required": [
    "account_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_account_invitations tool."
}
json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the returned record."
          },
          "account_id": {
            "$ref": "#/properties/data/items/properties/id",
            "description": "The account id returned by the tool."
          },
          "email": {
            "type": "string",
            "description": "The email returned by the tool."
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "admin",
              "member"
            ],
            "description": "The role returned by the tool."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "accepted",
              "revoked",
              "expired"
            ],
            "description": "Pending invitations are reported as expired after `expires_at`."
          },
          "expires_at": {
            "type": "string",
            "description": "The expires at returned by the tool."
          },
          "invited_by_user_id": {
            "anyOf": [
              {
                "$ref": "#/properties/data/items/properties/id",
                "description": "The invited by user id returned by the tool."
              },
              {
                "type": "null",
                "description": "The invited by user id returned by the tool."
              }
            ],
            "description": "The invited by user id returned by the tool."
          },
          "accepted_by_user_id": {
            "anyOf": [
              {
                "$ref": "#/properties/data/items/properties/id",
                "description": "The accepted by user id returned by the tool."
              },
              {
                "type": "null",
                "description": "The accepted by user id returned by the tool."
              }
            ],
            "description": "The accepted by user id returned by the tool."
          },
          "resolved_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The resolved at returned by the tool."
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "account_id",
          "email",
          "role",
          "status",
          "expires_at",
          "invited_by_user_id",
          "accepted_by_user_id",
          "resolved_at",
          "created_at"
        ],
        "additionalProperties": false,
        "description": "One data item returned by the tool."
      },
      "description": "Account invitations, newest first, filtered by status. Pending is the default. Acceptance tokens are never included."
    },
    "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": "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_account_invitations tool."
}