Lister les documents avec l'API PandaDoc

Liste les documents du workspace avec id, name, status et dates, 50 par page par défaut. Demandez la page suivante avec page ; une page avec moins de résultats que count est la dernière.

Identifiant
pandadoc_list_documents

L'appel

POST https://connect.reportei.com/api/tools/pandadoc_list_documents/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "q": "<q>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
qstringNonText matched against the document name or reference number.
statusintegerNonOnly documents in this status: 0 draft, 1 sent, 2 completed, 3 uploaded, 4 error, 5 viewed, 6 waiting approval, 7 approved, 8 rejected, 9 waiting payment, 10 paid, 11 voided, 12 declined, 13 external review, 14 scheduled.Valeurs : 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
template_idstringNonOnly documents created from this template, with the id from List templates.
folder_uuidstringNonOnly documents in this folder, with the uuid from List document folders.
tagstringNonOnly documents with this tag.
created_fromstringNonOnly documents created at or after this moment, like 2026-10-01T00:00:00Z.
created_tostringNonOnly documents created before this moment.
modified_fromstringNonOnly documents modified at or after this moment.
modified_tostringNonOnly documents modified before this moment.
completed_fromstringNonOnly documents completed at or after this moment.
completed_tostringNonOnly documents completed before this moment.
deletedbooleanNonWhen true, returns only deleted documents.
order_bystringNonSort field. A leading minus sorts in descending order, like -date_created for the newest first.Valeurs : name, date_created, date_status_changed, date_of_last_action, date_modified, date_sent, date_completed, date_expiration, date_declined, status, -name, -date_created, -date_status_changed, -date_of_last_action, -date_modified, -date_sent, -date_completed, -date_expiration, -date_declined, -status
countintegerNonDocuments per page, up to 100. Defaults to 50.
pageintegerNonPage to return, starting at 1.

Connexions possibles

Votre client connecte son compte PandaDoc une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/pandadoc, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/pandadoc_list_documents. Il devient la définition de tool de votre agent sans conversion.

Autres tools PandaDoc

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.