Skip to main content
Glama
signnow
by signnow

Get invite status

get_invite_status
Read-onlyIdempotent

Retrieve the current invite status and type (field or freeform) for a document or document group by providing its ID.

Instructions

Get invite status for a document or document group. Supports field invites and freeform invites (field invite is preferred when both exist). For freeform document groups, uses the group documents list so signature_requests include signer emails when the API provides them. Returns invite_mode 'field' or 'freeform'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesID of the document or document group
entity_typeNoType of entity: 'document' or 'document_group' (optional). If you're passing it, make sure you know what type you have. If it's not found, try using a different type.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
stepsYesList of steps in the invite
statusYesOverall invite status: 'created', 'pending', 'fulfilled'
invite_idYesID of the invite
invite_modeNofield = role/field invite path; freeform = mapped from free-form or group documents listfield

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Addedv2.4.0
  2. Removedv2.2.3
  3. Changed8 schema fields changedv2.2.1
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / $defs
      Removed value: -{
      -  "DocumentGroupStatusAction": {
      -    "description": "Action status within a document group invite step.",
      -    "properties": {
      -      "action": {
      -        "description": "Action type: 'view', 'sign', 'approve'",
      -        "type": "string"
      -      },
      -      "document_id": {
      -        "description": "ID of the document",
      -        "type": "string"
      -      },
      -      "email": {
      -        "description": "Recipient's email address",
      -        "type": "string"
      -      },
      -      "role": {
      -        "description": "Role name for this action",
      -        "type": "string"
      -      },
      -      "status": {
      -        "description": "Action status: 'created', 'pending', 'fulfilled'",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "email",
      -      "document_id",
      -      "status",
      -      "role"
      -    ],
      -    "type": "object"
      -  },
      -  "DocumentGroupStatusStep": {
      -    "description": "Step status within a document group invite.",
      -    "properties": {
      -      "actions": {
      -        "description": "List of actions in this step",
      -        "items": {
      -          "$ref": "#/$defs/DocumentGroupStatusAction"
      -        },
      -        "type": "array"
      -      },
      -      "order": {
      -        "description": "Step order number",
      -        "type": "integer"
      -      },
      -      "status": {
      -        "description": "Step status: 'created', 'pending', 'fulfilled'",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "status",
      -      "order",
      -      "actions"
      -    ],
      -    "type": "object"
      -  }
      -}
    • addedOutput schema / properties / invite_mode
      Added value: +{
      +  "default": "field",
      +  "description": "field = role/field invite path; freeform = mapped from free-form or group documents list",
      +  "enum": [
      +    "field",
      +    "freeform"
      +  ],
      +  "type": "string"
      +}
    • removedOutput schema / properties / steps / items / $ref
      Removed value: -"#/$defs/DocumentGroupStatusStep"
    • addedOutput schema / properties / steps / items / description
      Added value: +"Step status within a document group invite."
    • addedOutput schema / properties / steps / items / properties
      Added value: +{
      +  "actions": {
      +    "description": "List of actions in this step",
      +    "items": {
      +      "description": "Action status within a document group invite step.",
      +      "properties": {
      +        "action": {
      +          "description": "Action type: 'view', 'sign', 'approve'",
      +          "type": "string"
      +        },
      +        "document_id": {
      +          "description": "ID of the document",
      +          "type": "string"
      +        },
      +        "email": {
      +          "description": "Recipient's email address",
      +          "type": "string"
      +        },
      +        "role": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "description": "Role name for field invites; None for freeform invites"
      +        },
      +        "status": {
      +          "description": "Action status: 'created', 'pending', 'fulfilled'",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "action",
      +        "email",
      +        "document_id",
      +        "status"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "order": {
      +    "description": "Step order number",
      +    "type": "integer"
      +  },
      +  "status": {
      +    "description": "Step status: 'created', 'pending', 'fulfilled'",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / steps / items / required
      Added value: +[
      +  "status",
      +  "order",
      +  "actions"
      +]
    • addedOutput schema / properties / steps / items / type
      Added value: +"object"
  4. Changed18 schema fields changedv1.0.0
    • removedInput schema / properties / entity_id / title
      Removed value: -"Entity Id"
    • removedInput schema / properties / entity_type / title
      Removed value: -"Entity Type"
    • removedOutput schema / $defs / DocumentGroupStatusAction / properties / action / title
      Removed value: -"Action"
    • removedOutput schema / $defs / DocumentGroupStatusAction / properties / document_id / title
      Removed value: -"Document Id"
    • removedOutput schema / $defs / DocumentGroupStatusAction / properties / email / title
      Removed value: -"Email"
    • addedOutput schema / $defs / DocumentGroupStatusAction / properties / role
      Added value: +{
      +  "description": "Role name for this action",
      +  "type": "string"
      +}
    • removedOutput schema / $defs / DocumentGroupStatusAction / properties / role_name
      Removed value: -{
      -  "description": "Role name for this action",
      -  "title": "Role Name",
      -  "type": "string"
      -}
    • removedOutput schema / $defs / DocumentGroupStatusAction / properties / status / title
      Removed value: -"Status"
    • changedOutput schema / $defs / DocumentGroupStatusAction / required
      Previous value: -[
      -  "action",
      -  "email",
      -  "document_id",
      -  "status",
      -  "role_name"
      -]New value: +[
      +  "action",
      +  "email",
      +  "document_id",
      +  "status",
      +  "role"
      +]
    • removedOutput schema / $defs / DocumentGroupStatusAction / title
      Removed value: -"DocumentGroupStatusAction"
    • removedOutput schema / $defs / DocumentGroupStatusStep / properties / actions / title
      Removed value: -"Actions"
    • removedOutput schema / $defs / DocumentGroupStatusStep / properties / order / title
      Removed value: -"Order"
    • removedOutput schema / $defs / DocumentGroupStatusStep / properties / status / title
      Removed value: -"Status"
    • removedOutput schema / $defs / DocumentGroupStatusStep / title
      Removed value: -"DocumentGroupStatusStep"
    • removedOutput schema / properties / invite_id / title
      Removed value: -"Invite Id"
    • removedOutput schema / properties / status / title
      Removed value: -"Status"
    • removedOutput schema / properties / steps / title
      Removed value: -"Steps"
    • removedOutput schema / title
      Removed value: -"InviteStatus"
  5. First observed

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already provide readOnlyHint, destructiveHint, idempotentHint, openWorldHint. The description adds value by detailing internal logic: preferring field invites when both exist, and adapting behavior for freeform document groups to include signer emails. No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is four sentences, each conveying essential information without redundancy. It is front-loaded with the core purpose and efficiently explains nuances and behavior.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (two entity types, invite modes) and the presence of an output schema, the description adequately covers key behavioral aspects: invite mode preference, freeform group handling, and returned modes. No apparent gaps for a read-only tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents both parameters. The description adds practical guidance for entity_type, advising to ensure correct type and suggesting trying alternatives if not found, which aids correct invocation beyond schema details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool retrieves invite status for a document or document group, distinguishing it from related tools like 'send_invite' or 'cancel_invite'. It further clarifies support for field and freeform invites, and notes the return of invite_mode, making the purpose specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implicitly guides usage by focusing on reading invite status, contrasting with sibling tools that create or modify invites. It explains preferences (field over freeform) and behavior for freeform groups, but does not explicitly state when not to use this tool or list alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/signnow/sn-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server