Get fields for document generation

GET

/v1/cards/{cardId}/templates/{templateId}/fields

Returns the field structure pre-filled with the card's data, ready to serve as the basis for the document generation request body. The response includes the clients linked to the card (clients) and the template's other general sections (generalSections), each already listing the fields that need to be filled in.

Always use the result of this call as the starting point for the generation request body — it prevents mismatches between the structure the template expects and what is actually sent.

Requisição

Parâmetros de Caminho

Respostas

🟢200Fields found

application/json

Illustrative example of the response, with the field structure ready for document generation.

Bodyapplication/json

Response Example

{
    "clients": [
        {
            "clientId": "string",
            "name": "string",
            "index": 0,
            "fields": [
                {
                    "key": "string",
                    "title": "string",
                    "type": "string",
                    "value": null
                }
            ]
        }
    ],
    "generalSections": [
        {
            "section": "string",
            "title": "string",
            "index": 0,
            "fields": [
                {
                    "key": "string",
                    "title": "string",
                    "required": true,
                    "type": "string",
                    "value": null
                }
            ]
        }
    ]
}

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

Página anterior

Update automatic document configuration

Próxima página

Generate document from template