v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar documentos enviados para assinaturas

get/signatureDocuments

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima pagina.

statusinteger

Filtrar de acordo com o status do documento de assinatura. -1= cancelado | 0= Não assinado | 1= Enviado para assinatura | 2 = Assinado por todos

owner_idinteger

Dono da oportunidade onde a proposta está.

pipeline_idstring

Pipeline em que a oportunidade da proposta está.

created_at_startstring date-time

Filtrar documentos de assinatura a partir da data de atualização informada.

created_at_endstring date-time

Filtrar documentos de assinatura até a da data de criação informada.

updated_at_startstring date-time

Filtrar documentos de assinatura a partir da data de atualização informada.

updated_at_endstring date-time

Filtrar documentos de assinatura a até a data de atualização informada.

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "name": "16:01:40 10/12  teste novamente - ORC1604",
      "file": "https://assets.pipe.run/account/..../...pdf",
      "hash": "6d7b....5c1dde",
      "status": 2,
      "deal_id": 123,
      "account_id": 123,
      "proposal_id": 123,
      "signatures_ok": 1,
      "signatures_count": 1,
      "created_at": "2025-07-09 17:17:58",
      "updated_at": "2025-07-09 17:18:50",
      "type": 1,
      "generated_subscriptions_page": true,
      "signatures": [
        {
          "id": 123,
          "account_id": 123,
          "signature_document_id": 123,
          "email": "email do assinante",
          "hash": "1afe5..............cb",
          "name": "Nome do assinante",
          "document_id": "cpf/cnpj do assinante",
          "birth_day": "1988-02-20",
          "sign_date": "2025-07-09 17:18:47",
          "ip": "ip do assinante",
          "image": "data:image/png;base64,iVBORw0......KGgoAAA....=",
          "status": 1
        }
      ]
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZC...MiOnRydWV9"
    }
  }
}