Listagem de Modelos

Vamos buscar todos os modelos cadastrados no sistema ou buscar um modelo específico através do seu id.

`GET` /templates

Clique aqui para testar endpoint

🚧
Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}'
}

Exemplo de resposta:

{
    "data": [
        {
            "content": null,
            "description": "Descrição do modelo",
            "editor": "tinymce",
            "forms": [],
            "html": null,
            "id": 2829,
            "inserted_at": "2024-06-04T16:50:22",
            "json_data": null,
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-06-04T12:19:52",
                "workflows": null
            },
            "read_only_instances": true,
            "title": "Modelo API Contraktor Título",
            "updated_at": "2024-06-04T16:50:22"
        },
        {
            "content": null,
            "description": null,
            "editor": "tinymce",
            "forms": [],
            "html": "<div class=\"mce-page\" contenteditable=\"false\">\n<div class=\"mce-header\" style=\"height: 2cm; padding-left: 2cm; padding-right: 2cm;\" tabindex=\"-1\" contenteditable=\"true\">\n<p style=\"text-align: center;\">&nbsp;</p>\n<p style=\"text-align: center;\"><span style=\"color: #ffffff; background-color: #000000;\"><strong>ESSE FORMULÁRIO NÃO É VÁLIDO E NÃO ESTÁ ATIVADO. </strong></span></p>\n<p style=\"text-align: center;\"><span style=\"color: #ffffff; background-color: #000000;\"><strong>SERVE APENAS COMO MODELO DEMONSTRATIVO.</strong></span></p>\n</div>\n<div class=\"mce-main\" style=\"padding-right: 2cm; padding-left: 2cm;\" tabindex=\"-1\" contenteditable=\"true\">\n<p>&nbsp;</p>\n<table style=\"height: 22px; width: 100%; border-collapse: collapse; border-style: hidden;\" border=\"1\">\n<tbody>\n<tr style=\"height: 22px;\">\n<td style=\"width: 100%; height: 22px; border-color: #757171; text-align: center;\">\n<p>&nbsp;</p>\n<p><span style=\"text-decoration: underline; font-size: 18pt; color: #808080;\"><strong>FICHA CADASTRAL</strong></span></p>\n<p>&nbsp;</p>\n</td>\n</tr>\n</tbody>\n</table>\n<p style=\"text-align: justify;\">&nbsp;</p>\n<p style=\"text-align: justify;\"><span style=\"color: #808080;\"><em><span style=\"text-decoration: underline;\">Instruções: adicionar texto desejado</span></em></span></p>\n<p style=\"text-align: justify;\">&nbsp;</p>\n<p style=\"text-align: justify;\">&nbsp;</p>\n<table style=\"height: 345px; width: 100%; border-collapse: collapse; border-style: hidden;\" border=\"1\">\n<tbody>\n<tr style=\"height: 47px;\">\n<td style=\"width: 100%; height: 47px; border-style: hidden; text-align: center;\" colspan=\"2\">\n<p>&nbsp;</p>\n<p><span style=\"text-decoration: underline;\"><strong><span style=\"color: #808080; text-decoration: underline;\">DADOS DA CONTRATANTE</span></strong></span></p>\n<p>&nbsp;</p>\n</td>\n</tr>\n<tr style=\"height: 18px;\">\n<td style=\"width: 43.458%; height: 50px; background-color: #c3d5fa;\"><span style=\"color: #808080;\">Razão Social:</span></td>\n<td style=\"width: 56.542%; height: 50px; background-color: #c3d5fa;\"><span style=\"font-weight: 400;\"><span class=\"mce-field mode-input required\" contenteditable=\"false\" data-field-key=\"company.name\" data-field-match=\"Contratada\" data-field-required=\"true\" data-field-mode=\"input\">Empresa > Razão social (Contratada)</span></span></td>\n</tr>\n<tr style=\"height: 39px;\">\n<td style=\"width: 43.458%; height: 39px;\"><span style=\"color: #808080;\">Rua (endereço):</span></td>\n<td style=\"width: 56.542%; height: 39px;\"><span style=\"font-weight: 400;\"><span class=\"mce-field mode-input required\" contenteditable=\"false\" data-field-key=\"company.address_street\" data-field-match=\"Contratada\" data-field-required=\"true\" data-field-mode=\"input\">Empresa > Endereço > Logradouro (Contratada)</span></span></td>\n</tr>\n<tr style=\"height: 39px;\">\n            "id": 1699,
            "inserted_at": "2023-12-15T19:35:45",
            "json_data": null,
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-06-04T12:19:52",
                "workflows": null
            },
            "read_only_instances": false,
            "title": "Ficha Cadastral",
            "updated_at": "2024-06-04T16:39:56"
        },
        {
            "content": null,
            "description": "Descrição do modelo",
            "editor": "tinymce",
            "forms": [],
            "html": null,
            "id": 2811,
            "inserted_at": "2024-05-09T19:06:15",
            "json_data": null,
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-06-04T12:19:52",
                "workflows": null
            },
            "read_only_instances": true,
            "title": "Modelo API Contraktor",
            "updated_at": "2024-05-09T19:06:15"
        },
        {
            "content": null,
            "description": null,
            "editor": "tinymce",
            "forms": [],
            "html": "[HTML content truncated for brevity]",
            "id": 1700,
            "inserted_at": "2023-12-15T19:35:45",
            "json_data": null,
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-06-04T12:19:52",
                "workflows": null
            },
            "read_only_instances": false,
            "title": "Minuta Contratual",
            "updated_at": "2023-12-15T19:35:45"
        }
    ],
    "page_number": 1,
    "page_size": 16,
    "total_pages": 1
}

📝
O retorno desse endpoint será um array de objetos contendo todos os modelos já cadastrados.

`GET` /templates/{template_id}

Testar endpoint

⚠️
Para listar um modelo específico, substitua o parâmetro da rota {template_id}, pelo valor id do modelo que deseja buscar.

Exemplo de resposta:

{
    "data": {
        "content": null,
        "description": "Descrição do modelo",
        "editor": "tinymce",
        "forms": [],
        "html": null,
        "id": 2829,
        "inserted_at": "2024-06-04T16:50:22",
        "json_data": null,
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-06-04T12:19:52",
            "workflows": null
        },
        "read_only_instances": true,
        "title": "Modelo API Contraktor Título",
        "updated_at": "2024-06-04T16:50:22"
    }
}

Updated 17 days ago