Docs
Dashboard Get an API key

MCP tool

list_pacts

Pacts by status, most recently updated first. Defaults to active (drafts and sent), where the REST call defaults to all.

Read-onlyIdempotent

What the model sees

The tool's own description, which is how the assistant decides when to use it:

Pacts newest first, with recipients and their status. status: active (draft + sent), all, or one of draft, sent, sealed, declined, voided, lapsed. Default active.

Arguments

statusstringdefault: active
active (drafts and sent), all, or one status.
One of active all draft sent sealed declined voided lapsed
limitintegerdefault: 50
Maximum rows, 1 to 200 (values outside are clamped).

Returns

The pacts and how many match. There is no offset: raise limit, or narrow status. It comes back as a single text content item holding this JSON.

dataarray of objects
Pacts without fields and events.
ShowHide pact attributes
uidstring
The pact's id: 8 letters and digits.
titlestring
Shown to signers and in emails (150 characters at most).
statusstring
See Pact lifecycle.
One of draft sent sealed declined voided lapsed
messagestring | null
Your note in the invitation email.
page_countinteger
Pages in the document.
created_bystring
Where it was created: the dashboard, the API or the MCP server.
One of web api mcp
current_signerinteger | null
The order of the signer whose turn it is while the pact is sent; otherwise null.
date_createdstring (date-time)
When the draft was created.
date_sentstring (date-time) | null
When it was sent.
date_lapsesstring (date-time) | null
When it lapses if it is not sealed first.
date_sealedstring (date-time) | null
When the last signer signed.
date_updatedstring (date-time)
When anything about it last changed.
documents_chargedinteger | null
Documents it used when it was sent. null on a draft.
documents_costinteger | null
What sending this draft will use: one document per 3 signers, rounded up. Only set on a draft.
sent_sha256string
SHA-256 (lowercase hex) of the PDF as sent. The sigil records it too.
signed_sha256string | null
SHA-256 of the signed PDF, once sealed.
recipientsarray of objects
Signers in order, then CCs.
ShowHide recipient attributes
orderinteger
Position, starting at 1. Signers come first, numbered in the order you gave them; CCs follow.
rolestring
Signers sign in order; a CC gets the finished copy.
One of signer cc
namestring
The recipient's name.
emailstring
The recipient's address, lowercased.
statusstring
Where this recipient is.
One of pending viewed signed declined
date_viewedstring (date-time) | null
When they first opened their signing link.
date_signedstring (date-time) | null
When they signed.
typed_namestring | null
The full name they typed when signing.
decline_reasonstring | null
Their reason, if they declined.
signing_urlstring
The private link for the signer whose turn it is. Anyone with it can sign as that person, so only give it to them.
Only with include_links=1, and only on the waiting signer.
linksobject
Where to get the files.
ShowHide child attributes
documentstring (URL)
The document as sent (download).
signedstring (URL) | null
The signed PDF, once sealed (download).
sigilstring (URL) | null
The sigil (certificate of completion), once sealed (download).
dashboardstring (URL)
The pact's page on the dashboard (needs a login).
totalinteger
Pacts matching status.

Errors

A failure comes back as a tool result with isError: true whose text is An error occurred invoking 'list_pacts': followed by the message, so the assistant can read it and tell you. The messages include:

  • Unknown status '{status}'.

REST equivalent

GETList pacts