GET File history
Com este endpoint você pode obter o histórico de um documento, este normalmente inicia quando o doc é enviado para a plataforma, e finaliza quando o mesmo é assinado. <br><br> Com este histórico você pode obter todas as informações do documento, como quando ele foi editado, se um e-mail de solicitação foi aberto, se o documento foi baixado por um visitante e etc. <br><br> O histórico é composto da data e hora da atividade, no horário de Brasília, da mensagem que diz o que ocorreu com o mesmo, do usuário e empresa responsável pela ação (Caso estejam vazios, significa que a ação foi executada por um convidado, ou seja, um usuário sem cadastro no sistema) e do tipo de atividade. <br><br> O tipo de atividade por ser um de 3 tipos, sendo <b>default</b> o padrão para atividades simples, <b>success</b> para conclusões de assinatura e <b>danger</b> para alertas de ações, como ativação de proteção e recusa de assinatura.<p>Os registros vêm em ordem decrescente de data e o texto de <code>activity</code> é devolvido sem HTML. Um <code>document_key</code> inexistente responde <code>200</code> com <code>data: []</code>.</p>
Request
- Base URLhttps://app.plugsign.com.br
- URLhttps://app.plugsign.com.br/api/histories/{file}
- AuthAPI key in header Authorization
Path parameters
Document key do arquivo.
Response
200
Example response
{
"data": [
{
"id": 10136,
"company": 1,
"file": "7pf8Shhi1Jxzmy8EOwF6JDhbTZH7iqJz",
"activity": "Arquivo enviado por Exemplo [No IP Detected].",
"time": "26/11/2024 14:24:42",
"type": "default"
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.