--- agentTools: projectIndex: https://developers.pipe.run/llms.txt --- # Listar documentos enviados para assinaturas *Endpoint* utilizado para **listar todos os documentos enviados para assinaturas** na conta do CRM PipeRun. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "application/json", "version": "1.1-CRM" }, "servers": [ { "url": "https://api.pipe.run/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "token", "in": "header" } } }, "security": [ { "sec0": [] } ], "paths": { "/signatureDocuments": { "get": { "summary": "Listar documentos enviados para assinaturas", "description": "", "operationId": "listar-documentos-enviados-para-assinatura", "parameters": [ { "name": "show", "in": "query", "description": "Número de itens na página de resultado.", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "cursor", "in": "query", "description": "Hash da próxima pagina.", "schema": { "type": "string", "default": "\"\"" } }, { "name": "status", "in": "query", "description": "Filtrar de acordo com o status do documento de assinatura. `-1`= cancelado | `0`= Não assinado | `1`= Enviado para assinatura | `2` = Assinado por todos", "schema": { "type": "integer", "format": "int32" } }, { "name": "owner_id", "in": "query", "description": "Dono da oportunidade onde a proposta está.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pipeline_id", "in": "query", "description": "Pipeline em que a oportunidade da proposta está.", "schema": { "type": "string" } }, { "name": "created_at_start", "in": "query", "description": "Filtrar documentos de assinatura a partir da data de atualização informada.", "schema": { "type": "string", "format": "date-time", "default": "2025-10-02 00:00:00" } }, { "name": "created_at_end", "in": "query", "description": "Filtrar documentos de assinatura até a da data de criação informada.", "schema": { "type": "string", "format": "date-time", "default": "2025-10-02 00:00:00" } }, { "name": "updated_at_start", "in": "query", "description": "Filtrar documentos de assinatura a partir da data de atualização informada.", "schema": { "type": "string", "format": "date-time", "default": "2025-10-02 00:00:00" } }, { "name": "updated_at_end", "in": "query", "description": "Filtrar documentos de assinatura a até a data de atualização informada.", "schema": { "type": "string", "format": "date-time", "default": "2025-10-02 00:00:00" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"message\": \"OK\",\n \"data\": [\n {\n \"id\": 123,\n \"name\": \"16:01:40 10/12 teste novamente - ORC1604\",\n \"file\": \"https://assets.pipe.run/account/..../...pdf\",\n \"hash\": \"6d7b....5c1dde\",\n \"status\": 2,\n \"deal_id\": 123,\n \"account_id\": 123,\n \"proposal_id\": 123,\n \"signatures_ok\": 1,\n \"signatures_count\": 1,\n \"created_at\": \"2025-07-09 17:17:58\",\n \"updated_at\": \"2025-07-09 17:18:50\",\n \"type\": 1,\n \"generated_subscriptions_page\": true,\n \"signatures\": [\n {\n \"id\": 123,\n \"account_id\": 123,\n \"signature_document_id\": 123,\n \"email\": \"email do assinante\",\n \"hash\": \"1afe5..............cb\",\n \"name\": \"Nome do assinante\",\n \"document_id\": \"cpf/cnpj do assinante\",\n \"birth_day\": \"1988-02-20\",\n \"witness\": 0,\n \"sign_date\": \"2025-07-09 17:18:47\",\n \"ip\": \"ip do assinante\",\n \"image\": \"data:image/png;base64,iVBORw0......KGgoAAA....=\",\n \"status\": 1\n }\n ],\n \"deal\": {\t},\n \"files\": [ ]\n }\n ],\n \"meta\": {\n \"cursor\": {\n \"current\": null,\n \"prev\": null,\n \"next\": \"eyJpZC...MiOnRydWV9\",\n \"count\": null\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "OK" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 123, "default": 0 }, "name": { "type": "string", "example": "16:01:40 10/12 teste novamente - ORC1604" }, "file": { "type": "string", "example": "https://assets.pipe.run/account/..../...pdf" }, "hash": { "type": "string", "example": "6d7b....5c1dde" }, "status": { "type": "integer", "example": 2, "default": 0 }, "deal_id": { "type": "integer", "example": 123, "default": 0 }, "account_id": { "type": "integer", "example": 123, "default": 0 }, "proposal_id": { "type": "integer", "example": 123, "default": 0 }, "signatures_ok": { "type": "integer", "example": 1, "default": 0 }, "signatures_count": { "type": "integer", "example": 1, "default": 0 }, "created_at": { "type": "string", "example": "2025-07-09 17:17:58" }, "updated_at": { "type": "string", "example": "2025-07-09 17:18:50" }, "type": { "type": "integer", "example": 1, "default": 0 }, "generated_subscriptions_page": { "type": "boolean", "example": true, "default": true }, "signatures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 123, "default": 0 }, "account_id": { "type": "integer", "example": 123, "default": 0 }, "signature_document_id": { "type": "integer", "example": 123, "default": 0 }, "email": { "type": "string", "example": "email do assinante" }, "hash": { "type": "string", "example": "1afe5..............cb" }, "name": { "type": "string", "example": "Nome do assinante" }, "document_id": { "type": "string", "example": "cpf/cnpj do assinante" }, "birth_day": { "type": "string", "example": "1988-02-20" }, "witness": { "type": "integer", "example": 0, "default": 0 }, "sign_date": { "type": "string", "example": "2025-07-09 17:18:47" }, "ip": { "type": "string", "example": "ip do assinante" }, "image": { "type": "string", "example": "data:image/png;base64,iVBORw0......KGgoAAA....=" }, "status": { "type": "integer", "example": 1, "default": 0 } } } }, "deal": { "type": "object", "properties": {} }, "files": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "meta": { "type": "object", "properties": { "cursor": { "type": "object", "properties": { "current": {}, "prev": {}, "next": { "type": "string", "example": "eyJpZC...MiOnRydWV9" }, "count": {} } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Not Found\"\n}" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "Not Found" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "686d5ab389846000619e863f:686d5ab389846000619e882e" } ```