Consultar template por ID

GET

/v1/cards/templates/{templateId}

Retorna os detalhes completos de um template de documento a partir do seu identificador — incluindo nome, processador utilizado, campos configurados e seções.

Use esta consulta para inspecionar a estrutura de um template já existente antes de reaproveitá-lo como referência para criar um novo, ou para conferir a configuração atual de campos e seções.

Requisição

Parâmetros de Caminho

Respostas

🟢200Template encontrado

application/json

Exemplo ilustrativo da resposta, com os detalhes completos do template.

Bodyapplication/json

Response Example

{
    "id": "string",
    "name": "string",
    "templateProcessor": "string",
    "scope": "string",
    "active": true,
    "sections": [
        {
            "section": "string",
            "title": "string",
            "index": 0
        }
    ],
    "fields": [
        {
            "key": "string",
            "title": "string",
            "type": "default",
            "path": "string",
            "reference": "string",
            "required": true,
            "uiComponent": "short-text",
            "section": "string",
            "options": [
                "string"
            ],
            "children": [
                {}
            ]
        }
    ],
    "fileDownloadUrl": "string"
}

Modificado em 2026-07-28 20:38:32

Página anterior

Gerar documento a partir de template

Próxima página

Listar templates do card