SuperSign - API Oficial
  1. Modelos
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
      • Criar um envelope a partir de um modelo
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar e enviar envelope numa chamada
        • Gerar URL de download do envelope em ZIP
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Consultar envelope
        • Mover envelope para outra pasta
        • Anular envelope
      • Participantes
        • Listar participantes do envelope
        • Aprovar participante aprovador
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Confirmar o PDF convertido de um DOCX
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Listar todas as pastas
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Listar entregas de um webhook
        • Detalhar uma entrega de webhook
        • Reenviar uma entrega de webhook
        • Girar o segredo de assinatura do webhook
        • Criar webhook
        • Listar webhooks
        • Atualizar webhook
      • Modelos
        • Listar modelos
          GET
        • Consultar modelo
          GET
        • Criar envelope a partir de modelo
          POST
  1. Modelos

Consultar modelo

Sandbox
Sandbox
GET
/v4/api/templates/{templateId}
Retorna documentos, vagas de participante e campos posicionados de um modelo — os dados necessários para criar um envelope a partir dele.

Requisição

Parâmetros de Caminho

Respostas

🟢200OK
application/json
Sucesso
Headers

Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v4/api/templates/'
Response Response Example
200 - Exemplo 1
{
    "id": "string",
    "title": "string",
    "description": "string",
    "status": "DRAFT",
    "isPrivate": true,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "documents": [
        {
            "id": "string",
            "name": "string",
            "pageCount": 0,
            "fileSize": 0,
            "order": 0,
            "url": "http://example.com",
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "participants": {
        "signatories": [
            {
                "id": "string",
                "templateId": "string",
                "type": "INDIVIDUAL",
                "role": "SIGNATORY",
                "roleName": "string",
                "group": {
                    "id": "string",
                    "name": "string"
                },
                "name": "string",
                "email": "string",
                "phoneNumber": "string",
                "deliveryMethod": "EMAIL",
                "order": 0,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z",
                "qualification": "string",
                "documentNumber": "string",
                "authMethod": "EMAIL",
                "isForeigner": true
            }
        ],
        "approvers": [
            {
                "id": "string",
                "templateId": "string",
                "type": "INDIVIDUAL",
                "role": "SIGNATORY",
                "roleName": "string",
                "group": {
                    "id": "string",
                    "name": "string"
                },
                "name": "string",
                "email": "string",
                "phoneNumber": "string",
                "deliveryMethod": "EMAIL",
                "order": 0,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        ],
        "observers": [
            {
                "id": "string",
                "templateId": "string",
                "type": "INDIVIDUAL",
                "role": "SIGNATORY",
                "roleName": "string",
                "group": {
                    "id": "string",
                    "name": "string"
                },
                "name": "string",
                "email": "string",
                "phoneNumber": "string",
                "deliveryMethod": "EMAIL",
                "order": 0,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z",
                "mandatoryView": true
            }
        ]
    },
    "fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "templateParticipantId": "32527aac-72a1-4540-bccb-de6257c0c706",
            "pages": [
                1
            ],
            "position": {
                "x": 0,
                "y": 0
            },
            "size": {
                "width": 0,
                "height": 0
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "type": "SIGNATURE",
            "properties": {},
            "templateDocumentId": "string"
        }
    ]
}
Modificado em 2026-09-18 17:26:39
Página anterior
Listar modelos
Próxima página
Criar envelope a partir de modelo
Built with