Listar documentos no PandaDoc, por uma API
Lista os documentos do workspace com id, name, status e datas, 50 por página por padrão. Peça a próxima página com page; uma página com menos resultados que count é a última.
- Identificador
- pandadoc_list_documents
A chamada
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>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| q | string | Não | Text matched against the document name or reference number. |
| status | integer | Não | 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 | Não | Only documents created from this template, with the id from List templates. |
| folder_uuid | string | Não | Only documents in this folder, with the uuid from List document folders. |
| tag | string | Não | Only documents with this tag. |
| created_from | string | Não | Only documents created at or after this moment, like 2026-10-01T00:00:00Z. |
| created_to | string | Não | Only documents created before this moment. |
| modified_from | string | Não | Only documents modified at or after this moment. |
| modified_to | string | Não | Only documents modified before this moment. |
| completed_from | string | Não | Only documents completed at or after this moment. |
| completed_to | string | Não | Only documents completed before this moment. |
| deleted | boolean | Não | When true, returns only deleted documents. |
| order_by | string | Não | 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 | Não | Documents per page, up to 100. Defaults to 50. |
| page | integer | Não | Page to return, starting at 1. |
Conexões possíveis
O seu cliente conecta a conta do PandaDoc uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/pandadoc, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/pandadoc_list_documents. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do PandaDoc
- Obter documentoGETRetorna os detalhes de um documento: status, destinatários com seu id, has_completed e shared_link, campos, tokens, preços, textos, metadata e tags. Funciona depois que o documento sai do status document.uploaded.
- Obter status do documentoGETRetorna o id, o name e o status de um documento. Depois de Create document, o status fica document.uploaded por alguns segundos; aguarde document.draft antes de atualizar ou enviar.
- Criar documentoPOSTCria um documento a partir de um template (template_uuid) ou de um PDF público (url e name). Fica em document.uploaded por alguns segundos e depois vira document.draft. Nada é enviado: chame Send document quando Get document status mostrar document.draft.
- Atualizar documentoPATCHAtualiza um documento no status document.draft: name, destinatários, variáveis, campos, blocos de texto, tabelas de preços, metadata e tags. Para um documento já enviado, chame Move document to draft antes.
- Mover documento para rascunhoPOSTMove um documento enviado ou concluído de volta para document.draft, para que Update document possa alterá-lo. Os campos de assinatura e de iniciais são limpos, os destinatários não são avisados e o documento precisa ser enviado de novo.
- Enviar documentoPOSTEnvia um documento no status document.draft aos destinatários, por email a menos que silent seja true, e o move para document.sent, o que trava sua estrutura. Com uma chave de sandbox, os destinatários devem ter o mesmo domínio de email do remetente.
- Enviar lembrete do documentoPOSTEnvia agora um lembrete aos destinatários que ainda precisam concluir um documento enviado. O resultado diz, por destinatário, se cada lembrete saiu; com ordem de assinatura, só o signatário atual pode ser lembrado.
- Excluir documentoDELETEExclui um documento. Com forever false ele vai para a Lixeira, de onde pode ser restaurado; sem forever, o PandaDoc o exclui de forma permanente.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
