Retornos

- id: Identificador interno utilizado. - name: O nome do documento na plataforma, o mesmo será exibido no front-end para organização e poderá ser utilizado como filtro para consultas. - file_name: O nome do arquivo utilizado para o endpoint de download. - extension: O formato atual do documento, que será alterado caso o mesmo seja convertido para PDF. - size: tamanho do documento em bytes. - status: Se o documento já foi assinado por alguém no sistema, mesmo que o mesmo ainda possua assinaturas pendentes. - document_key: Parâmetro chave que será utilizado para identificar o documento na API, será necessário o mesmo para realizar solicitações de assinatura. - editted: Se o documento já foi editado/assinado por qualquer pessoa, seja via API ou front-end. - is_template: Se o documento é um template (Consulte a documentação de templates). - template_fields: Campos de preenchimento e/ou assinatura definidos para este documento (Consulte a documentação de templates). - acessibility: Tipo de acesso permitido no documento no front-end, podendo ser privado para quem o enviou, público para todos os colaboradores da empresa (Clientes não tem este acesso), ou privado aos membros do departamento de quem o enviou. - departments: Departamentos que possuem acesso ao documento. - folder: Pasta e subpastas até onde o documento está localizado. - uploaded_by: Usuário que enviou o documento para a plataforma (Em caso de envio pela API, sempre será feito pelo administrador da conta). - uploaded_on: Data e hora na qual o documento foi enviado (Todas as datas e horas são sincronizadas no fuso horário de Brasília. - download: Endpoint único para recuperação do documento e download.

Filtros

- folder: ID da pasta dos documentos. - name: Nome do documento na plataforma (Pode ser parcial, Ex: "contr" vai retornar "contrato"). - file_name: Nome do documento para download. - document_key: Chave do documento na API. - editted: Se o documento já foi editado (Yes , No). - is_template: Filtrar por templates ou documentos comuns (Yes, No).

Para listar todos os arquivos da pasta principal, defina o parâmetro 'folder' com o valor 1 no filtro.