Listar documentos en PandaDoc, con una API
Lista los documentos del workspace con id, name, status y fechas, 50 por página por defecto. Pide la página siguiente con page; una página con menos resultados que count es la última.
- Identificador
- pandadoc_list_documents
La llamada
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>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| q | string | No | Text matched against the document name or reference number. |
| status | integer | No | Only 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.Valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 |
| template_id | string | No | Only documents created from this template, with the id from List templates. |
| folder_uuid | string | No | Only documents in this folder, with the uuid from List document folders. |
| tag | string | No | Only documents with this tag. |
| created_from | string | No | Only documents created at or after this moment, like 2026-10-01T00:00:00Z. |
| created_to | string | No | Only documents created before this moment. |
| modified_from | string | No | Only documents modified at or after this moment. |
| modified_to | string | No | Only documents modified before this moment. |
| completed_from | string | No | Only documents completed at or after this moment. |
| completed_to | string | No | Only documents completed before this moment. |
| deleted | boolean | No | When true, returns only deleted documents. |
| order_by | string | No | Sort field. A leading minus sorts in descending order, like -date_created for the newest first.Valores: 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 |
| count | integer | No | Documents per page, up to 100. Defaults to 50. |
| page | integer | No | Page to return, starting at 1. |
Conexiones posibles
Tu cliente conecta su cuenta de PandaDoc una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/pandadoc, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/pandadoc_list_documents. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de PandaDoc
- Obtener documentoGETDevuelve los detalles de un documento: status, destinatarios con su id, has_completed y shared_link, campos, tokens, precios, textos, metadata y tags. Funciona una vez que el documento sale del estado document.uploaded.
- Obtener estado del documentoGETDevuelve el id, el name y el status de un documento. Después de Create document, el estado se queda en document.uploaded unos segundos; espera document.draft antes de actualizarlo o enviarlo.
- Crear documentoPOSTCrea un documento a partir de una plantilla (template_uuid) o de un PDF público (url y name). Queda en document.uploaded unos segundos y luego pasa a document.draft. No se envía nada: llama a Send document cuando Get document status muestre document.draft.
- Actualizar documentoPATCHActualiza un documento en estado document.draft: name, destinatarios, variables, campos, bloques de texto, tablas de precios, metadata y tags. Para un documento ya enviado, llama antes a Move document to draft.
- Mover documento a borradorPOSTMueve un documento enviado o completado de vuelta a document.draft para que Update document pueda modificarlo. Se borran los campos de firma e iniciales, los destinatarios no reciben aviso y el documento debe enviarse de nuevo.
- Enviar documentoPOSTEnvía un documento en estado document.draft a sus destinatarios, por email salvo que silent sea true, y lo pasa a document.sent, lo que bloquea su estructura. Con una clave de sandbox, los destinatarios deben compartir el dominio de email del remitente.
- Enviar recordatorio del documentoPOSTEnvía ahora un recordatorio a los destinatarios que aún deben completar un documento enviado. El resultado indica, por destinatario, si cada recordatorio salió; con orden de firma, solo se puede recordar al firmante actual.
- Eliminar documentoDELETEElimina un documento. Con forever false va a la Papelera, de donde se puede restaurar; sin forever, PandaDoc lo elimina de forma permanente.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
