Get document with the PandaDoc API
Returns the details of a document: status, recipients with their id, has_completed and shared_link, fields, tokens, pricing, texts, metadata and tags. Works once the document has left the document.uploaded status.
- Identifier
- pandadoc_get_document
The request
POST https://connect.reportei.com/api/tools/pandadoc_get_document/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Id of the document, from List documents or Create document. |
Supported connections
Your customer connects their PandaDoc account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/pandadoc, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/pandadoc_get_document. It becomes your agent's tool definition with no conversion.
Other PandaDoc tools
- List documentsGETLists the documents of the workspace with id, name, status and dates, 50 per page by default. Ask for the next page with page; a page with fewer results than count is the last one.
- Get document statusGETReturns the id, name and status of a document. After Create document the status stays document.uploaded for a few seconds; wait for document.draft before updating or sending it.
- Create documentPOSTCreates a document from a template (template_uuid) or from a public PDF (url and name). It stays document.uploaded for a few seconds and then turns document.draft. Nothing is sent: call Send document once Get document status shows document.draft.
- Update documentPATCHUpdates a document in the document.draft status: name, recipients, variables, fields, text blocks, pricing tables, metadata and tags. For a document already sent, call Move document to draft first.
- Move document to draftPOSTMoves a sent or completed document back to document.draft so Update document can change it. Signature and initials fields are cleared, recipients are not told, and the document must be sent again.
- Send documentPOSTSends a document in the document.draft status to its recipients, by email unless silent is true, and moves it to document.sent, which locks its structure. With a sandbox key, recipients must share the sender's email domain.
- Send document reminderPOSTSends a reminder now to recipients who still have to complete a sent document. The result says, per recipient, whether each reminder went out; with a signing order, only the current signer can be reminded.
- Delete documentDELETEDeletes a document. With forever false it goes to the Trash Bin, where it can be restored; without forever, PandaDoc deletes it permanently.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
