{"_id":"54dbbdf900add62300757897","parentDoc":null,"githubsync":"","__v":25,"user":"54da5cb85b80b62300dadc4b","category":{"_id":"54db48c86db3861700c840c5","__v":13,"version":"54da5d305b80b62300dadc51","pages":["54db4c2c7dadb3230051136b","54db4f1c74dfff3700f161d9","54db53fdeb78f13900cf108e","54db65ec1a14312100313971","54dbad189f8ef11900f4df66","54dbccb800add623007578b4","54ff74002882a10d00546966","55de2abb9067202b00ddfffb","55e4d19fe252ac0d00303a73","5654c2d82308e12b00a14add","56980f9c080e0c0d00a835dc","569810e0895fd40d00d4b2f8","56e30b3051857d0e008e77a1"],"project":"54da5d2f5b80b62300dadc4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-11T12:19:20.398Z","from_sync":false,"order":0,"slug":"rest-api","title":"Rest API"},"project":"54da5d2f5b80b62300dadc4e","version":{"_id":"54da5d305b80b62300dadc51","project":"54da5d2f5b80b62300dadc4e","__v":7,"createdAt":"2015-02-10T19:34:08.062Z","releaseDate":"2015-02-10T19:34:08.062Z","categories":["54da5d305b80b62300dadc52","54da704b11dfeb1900430309","54da705c44b1090d00072b34","54db48c86db3861700c840c5","54db48cd7dadb32300511364","54dbaa0c7dadb3230051143b","572b89f0b352ab0e003daca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1.0","version_clean":"1.0.0","version":"1"},"metadata":{"title":"","description":"","image":[]},"updates":["54dcdc88db3b362100131242","56f2ed1692cce10e00eaf067"],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T20:39:21.997Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \\n\\nEsta documentação é referente à API da plataforma Clicksign Classic.\",\n  \"title\": \"Utilize a nova plataforma de assinatura\"\n}\n[/block]\nVocê pode obter uma listagem de todos os documentos da conta, além de informações extras pertinentes ao andamento da lista de assinatura. A listagem retornará todos os documentos da conta.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atenção\",\n  \"body\": \"Requisição retorna apenas os documentos que estão na **raíz** do cofre padrão da conta, ou seja, os documentos que estão fora das pastas.\"\n}\n[/block]\n### Requisição\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"1-0\": \"Path\",\n    \"2-0\": \"Headers\",\n    \"1-1\": \"`/v1/documents/pages?page=:page&access_token=string`\\n\\n`:page` deve ser substituída pela página procurada.\",\n    \"0-1\": \"`GET`\",\n    \"2-1\": \"`Accept: application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Resposta\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 200 OK\\nContent-Type:application/json\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"pagination\\\": {\\n    \\\"total_itens\\\": 51,\\n    \\\"total_pages\\\": 3,\\n    \\\"per_page\\\": 25,\\n    \\\"current_page\\\": 2\\n  },\\n  \\\"documents\\\": [\\n    {\\n      \\\"document\\\": {\\n        \\\"key\\\": \\\"d941518f-8384-423c-afc9-90df31c5293f\\\",\\n        \\\"original_name\\\": \\\"Contrato de Prestação de Serviços.pdf\\\",\\n        \\\"status\\\": \\\"completed\\\",\\n        \\\"created_at\\\": \\\"2015-02-10T10:34:06.222-02:00\\\",\\n        \\\"updated_at\\\": \\\"2015-02-10T10:34:06.222-02:00\\\",\\n        \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n        \\\"list\\\": {\\n          \\\"started_at\\\": \\\"2015-02-10T10:34:05.847-02:00\\\",\\n          \\\"created_at\\\": \\\"2015-02-10T10:31:10.650-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-02-10T10:34:05.849-02:00\\\",\\n          \\\"user_key\\\": \\\"9B81-7D91-BF05-8811\\\",\\n          \\\"signatures\\\": [\\n            {\\n              \\\"display_name\\\": \\\"Carlos Pereira Magalhães\\\",\\n              \\\"title\\\": null,\\n              \\\"company_name\\\": null,\\n              \\\"documentation\\\": \\\"123.321.123-40\\\",\\n              \\\"key\\\": \\\"9B81-7D91-BF05-8811\\\",\\n              \\\"act\\\": \\\"sign\\\",\\n              \\\"decision\\\": \\\"agreed\\\",\\n              \\\"address\\\": \\\"178.189.153.186\\\",\\n              \\\"email\\\": \\\"carlos.magalhaes:::at:::empresa123.com\\\",\\n              \\\"signed_at\\\": \\\"2015-02-10T10:34:21.136-02:00\\\",\\n              \\\"allow_method\\\": \\\"token\\\",\\n              \\\"created_at\\\": \\\"2015-02-10T10:33:51.210-02:00\\\",\\n              \\\"updated_at\\\": \\\"2015-02-10T10:34:21.157-02:00\\\",\\n              \\\"skip_documentation\\\": false,\\n              \\\"phone_number\\\": \\\"\\\"\\n            },\\n            {\\n              \\\"display_name\\\": \\\"João Gregorio de Mattos\\\",\\n              \\\"title\\\": \\\"Diretor\\\",\\n              \\\"company_name\\\": \\\"Companhia Brasileira de Copos Plásticos\\\",\\n              \\\"documentation\\\": \\\"123.321.123-40\\\",\\n              \\\"key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n              \\\"act\\\": \\\"sign\\\",\\n              \\\"decision\\\": \\\"agreed\\\",\\n              \\\"address\\\": \\\"177.69.133.125\\\",\\n              \\\"email\\\": \\\"joao@cbcp.com.br\\\",\\n              \\\"signed_at\\\": \\\"2015-02-10T10:34:37.926-02:00\\\",\\n              \\\"allow_method\\\": \\\"token\\\",\\n              \\\"created_at\\\": \\\"2015-02-10T10:33:57.971-02:00\\\",\\n              \\\"updated_at\\\": \\\"2015-02-10T10:34:37.954-02:00\\\",\\n              \\\"skip_documentation\\\": false,\\n              \\\"phone_number\\\": \\\"\\\"\\n            }\\n          ]\\n        }\\n      }\\n    },\\n    {\\n      \\\"document\\\": {\\n        \\\"key\\\": \\\"88c4ebfa-05d8-44d8-bb42-cb2cf8e420f3\\\",\\n        \\\"original_name\\\": \\\"Contrato Editorial.docx\\\",\\n        \\\"status\\\": \\\"editing\\\",\\n        \\\"created_at\\\": \\\"2015-02-05T15:40:15.335-02:00\\\",\\n        \\\"updated_at\\\": \\\"2015-02-05T15:40:15.335-02:00\\\",\\n        \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n        \\\"list\\\": {\\n          \\\"started_at\\\": null,\\n          \\\"created_at\\\": \\\"2015-02-05T15:40:15.332-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-02-05T15:40:15.332-02:00\\\",\\n          \\\"signatures\\\": [\\n            {\\n              \\\"display_name\\\": \\\"marcos.azevedo@empresaabc.com\\\",\\n              \\\"title\\\": null,\\n              \\\"company_name\\\": null,\\n              \\\"documentation\\\": null,\\n              \\\"key\\\": null,\\n              \\\"act\\\": \\\"sign\\\",\\n              \\\"decision\\\": null,\\n              \\\"address\\\": null,\\n              \\\"email\\\": \\\"marcos.azevedo@empresaabc.com\\\",\\n              \\\"signed_at\\\": null,\\n              \\\"allow_method\\\": \\\"token\\\",\\n              \\\"created_at\\\": \\\"2015-02-11T12:09:19.015-02:00\\\",\\n              \\\"updated_at\\\": \\\"2015-02-11T12:10:05.146-02:00\\\",\\n              \\\"skip_documentation\\\": false,\\n              \\\"phone_number\\\": \\\"\\\"\\n            }\\n          ]\\n        }\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"listagem","type":"basic","title":"Listagem"}
[block:callout] { "type": "danger", "body": "Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \n\nEsta documentação é referente à API da plataforma Clicksign Classic.", "title": "Utilize a nova plataforma de assinatura" } [/block] Você pode obter uma listagem de todos os documentos da conta, além de informações extras pertinentes ao andamento da lista de assinatura. A listagem retornará todos os documentos da conta. [block:callout] { "type": "warning", "title": "Atenção", "body": "Requisição retorna apenas os documentos que estão na **raíz** do cofre padrão da conta, ou seja, os documentos que estão fora das pastas." } [/block] ### Requisição [block:parameters] { "data": { "0-0": "Method", "1-0": "Path", "2-0": "Headers", "1-1": "`/v1/documents/pages?page=:page&access_token=string`\n\n`:page` deve ser substituída pela página procurada.", "0-1": "`GET`", "2-1": "`Accept: application/json`" }, "cols": 2, "rows": 3 } [/block] ## Resposta [block:code] { "codes": [ { "code": "HTTP/1.1 200 OK\nContent-Type:application/json", "language": "http" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"pagination\": {\n \"total_itens\": 51,\n \"total_pages\": 3,\n \"per_page\": 25,\n \"current_page\": 2\n },\n \"documents\": [\n {\n \"document\": {\n \"key\": \"d941518f-8384-423c-afc9-90df31c5293f\",\n \"original_name\": \"Contrato de Prestação de Serviços.pdf\",\n \"status\": \"completed\",\n \"created_at\": \"2015-02-10T10:34:06.222-02:00\",\n \"updated_at\": \"2015-02-10T10:34:06.222-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"list\": {\n \"started_at\": \"2015-02-10T10:34:05.847-02:00\",\n \"created_at\": \"2015-02-10T10:31:10.650-02:00\",\n \"updated_at\": \"2015-02-10T10:34:05.849-02:00\",\n \"user_key\": \"9B81-7D91-BF05-8811\",\n \"signatures\": [\n {\n \"display_name\": \"Carlos Pereira Magalhães\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": \"123.321.123-40\",\n \"key\": \"9B81-7D91-BF05-8811\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"178.189.153.186\",\n \"email\": \"carlos.magalhaes@empresa123.com\",\n \"signed_at\": \"2015-02-10T10:34:21.136-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-02-10T10:33:51.210-02:00\",\n \"updated_at\": \"2015-02-10T10:34:21.157-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n },\n {\n \"display_name\": \"João Gregorio de Mattos\",\n \"title\": \"Diretor\",\n \"company_name\": \"Companhia Brasileira de Copos Plásticos\",\n \"documentation\": \"123.321.123-40\",\n \"key\": \"A11D-EBAD-1D86-B7B4\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"177.69.133.125\",\n \"email\": \"joao@cbcp.com.br\",\n \"signed_at\": \"2015-02-10T10:34:37.926-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-02-10T10:33:57.971-02:00\",\n \"updated_at\": \"2015-02-10T10:34:37.954-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n }\n ]\n }\n }\n },\n {\n \"document\": {\n \"key\": \"88c4ebfa-05d8-44d8-bb42-cb2cf8e420f3\",\n \"original_name\": \"Contrato Editorial.docx\",\n \"status\": \"editing\",\n \"created_at\": \"2015-02-05T15:40:15.335-02:00\",\n \"updated_at\": \"2015-02-05T15:40:15.335-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"list\": {\n \"started_at\": null,\n \"created_at\": \"2015-02-05T15:40:15.332-02:00\",\n \"updated_at\": \"2015-02-05T15:40:15.332-02:00\",\n \"signatures\": [\n {\n \"display_name\": \"marcos.azevedo@empresaabc.com\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": null,\n \"key\": null,\n \"act\": \"sign\",\n \"decision\": null,\n \"address\": null,\n \"email\": \"marcos.azevedo@empresaabc.com\",\n \"signed_at\": null,\n \"allow_method\": \"token\",\n \"created_at\": \"2015-02-11T12:09:19.015-02:00\",\n \"updated_at\": \"2015-02-11T12:10:05.146-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "language": "json", "name": "Body" } ] } [/block]