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âmetroTipoObrigatórioDescrição
qstringNãoText matched against the document name or reference number.
statusintegerNãoOnly 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_idstringNãoOnly documents created from this template, with the id from List templates.
folder_uuidstringNãoOnly documents in this folder, with the uuid from List document folders.
tagstringNãoOnly documents with this tag.
created_fromstringNãoOnly documents created at or after this moment, like 2026-10-01T00:00:00Z.
created_tostringNãoOnly documents created before this moment.
modified_fromstringNãoOnly documents modified at or after this moment.
modified_tostringNãoOnly documents modified before this moment.
completed_fromstringNãoOnly documents completed at or after this moment.
completed_tostringNãoOnly documents completed before this moment.
deletedbooleanNãoWhen true, returns only deleted documents.
order_bystringNãoSort 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
countintegerNãoDocuments per page, up to 100. Defaults to 50.
pageintegerNãoPage 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

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.