Visualizar todos os documentos

📘
Requisição para a visualização de parte dos metadados dos documentos na Clicksign. Essa é uma requisição GET para /api/v1/documents?page=number&, sendo number o número da página.

GET /api/v1/documents?page=number&access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Document: atributos do documento

Atributo	Descrição	Exemplo
`key`	Chave única do documento dentro da Clicksign.	55fea7c2-0e5b-40dc-bacf-50fb8529f866
`folder_id`	Caminho completo do documento dentro da Clicksign.	/Pasta 1/Pasta 2/Contrato de Prestação de Serviços-123.pd
`filename`	Nome do documento.	Contrato de Prestação de Serviços-123.pdf
`uploaded_at`	Data de upload do documento.	2018-06-21T16:47:32.115Z
`updated_at`	Data de atualização do documento.	2018-06-21T16:47:34.280Z
`finished_at`	Data de finalização do documento.	null
`deadline_at`	Data limite para a realização das assinaturas no documento.	2018-06-28T17:30:59.000Z
`status`	Status do documento. Possíveis valores: `running`: Documento em processo de assinatura. `closed`: Documento finalizado. `canceled`: Documento cancelado.	running
`auto_close`	Determina se o documento será finalizado automaticamente logo após a assinatura do último signatário.	true

Page_infos: atributos de listagem das páginas

📘
São listados até 30 documentos por página

Atributo	Descrição	Exemplo
`total_pages`	Quantidade total de páginas.	3
`current_page`	Número da página que está sendo visualizada.	1
`next_page`	Número da próxima página que será visualizada.	2
`prev_page`	Número da página anterior.	null
`first_page?`	Determina se é a primeira página da listagem.	true
`last_page?`	Determina se é a última página da listagem.	false

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

GET /api/v1/documents?page=1&access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "documents": [
   {
      "key": "db546702-67dc-4ecd-a06c-7486b78c84f9",
      "folder_id": 3292016,
      "filename": "Contrato de Prestação de Serviços.pdf",
      "uploaded_at": "2020-08-14T14:05:21.197-03:00",
      "updated_at": "2020-09-13T12:06:47.386-03:00",
      "finished_at": "2020-09-13T12:06:43.772-03:00",
      "deadline_at": "2020-09-13T11:58:26.365-03:00",
      "status": "canceled",
      "auto_close": true
    },
    {
      "key": "dd99448d-ed10-4f77-a8d3-7b2e4174afb4",
      "folder_id": 5197479,
      "filename": "Termo de Adesão.docx",
      "uploaded_at": "2020-08-13T17:32:59.804-03:00",
      "updated_at": "2020-09-10T11:11:04.021-03:00",
      "finished_at": "2020-09-10T11:10:56.609-03:00",
      "deadline_at": "2020-09-10T10:10:03.145-03:00",
      "status": "canceled",
      "auto_close": true
    },
    {
      "key": "82dbbe10-07b9-44f4-a74d-3b4aa7c2ed21",
      "folder_id": 5197479,
      "filename": "Contrato Exemplo.docx",
      "uploaded_at": "2020-08-13T17:32:58.234-03:00",
      "updated_at": "2020-09-10T11:11:01.383-03:00",
      "finished_at": "null",
      "deadline_at": "2020-09-10T10:10:01.273-03:00",
      "status": "running",
      "auto_close": true
    }
   ],
  "page_infos": {
    "total_pages": 3,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "first_page?": true,
    "last_page?": false
  }
}