These docs are for v2.0. Click to read the latest docs for v3.2.

Listar Pastas

GET /api/v3/folders

📘

Requisição para a listar todas as Pastas na sua conta Clicksign. Esta é uma requisição GET para /api/v3/folders.

GET /api/v3/folders HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

❗️

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/v3/folders HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
{
  "data": [
    {
      "id": "17790e58-132d-4a3b-b602-1cf0320370c6",
      "type": "folders",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/folders/17790e58-132d-4a3b-b602-1cf0320370c6"
      },
      "attributes": {
        "name": "Pasta 1.1",
        "path": "/Pasta 1",
        "in_root": false,
        "created": "2024-06-28T17:55:57.228-03:00",
        "modified": "2024-06-28T17:55:57.233-03:00"
      }
    },
    {
      "id": "2e600d78-cf8a-4856-9b9a-3d90ae44563c",
      "type": "folders",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/folders/2e600d78-cf8a-4856-9b9a-3d90ae44563c"
      },
      "attributes": {
        "name": "Pasta 1",
        "path": "",
        "in_root": true,
        "created": "2024-06-28T17:42:42.884-03:00",
        "modified": "2024-06-28T17:42:42.894-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 2
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/folders?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/folders?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}