Buscar Modelo

👍
Modelos de documentos
Com esta funcionalidade, você poderá utilizar templates criados em Microsoft Word para criação automática de documentos baseados em metadados. Confira mais em nossa página de Ajuda.

📘
Requisição para realização de busca e listagem de modelos criados na Clicksign. Esta é uma requisição GET para /api/v3/templates. Não é necessário enviar atributos no body dessa requisição.

GET /api/v3/templates HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

GET /api/v3/templates HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json; charset=utf-8

{
    "data": [
        {
            "id": "43a5a2f4-a1df-4367-a47e-aea6e4c6c3d4",
            "type": "templates",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/templates/43a5a2f4-a1df-4367-a47e-aea6e4c6c3d4",
                "files": {
                    "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMDgvMTkvMjAvMjgvZTVjYjkwM2UtODI5MC00OWJmLTgxODAtZDAzZWU2NGYwZmQzL2ZpbGUuZG9jeCJdXQ/Contrato%20de%20Presta%C3%A7%C3%A3o%20de%20Servi%C3%A7o%20-%20Exemplo%20%282%29.docx?sha=df435372a9fb07a5"
                }
            },
            "attributes": {
                "name": "Teste",
                "color": "#15d3c9",
                "created": "2023-08-08T16:20:33.787-03:00",
                "modified": "2023-08-08T16:20:33.787-03:00"
            }
        },
        {
            "id": "6370c899-5250-4e3b-b861-434e8824362b",
            "type": "templates",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/templates/6370c899-5250-4e3b-b861-434e8824362b",
                "files": {
                    "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMjIvMTQvMTIvNDEvNmJhYTFhYzQtZWE2Zi00ZWVmLWI4OWYtMGEzMjA1MDJiZDc3L2ZpbGUuZG9jeCJdXQ/file.docx?sha=3b10e951572327b8"
                }
            },
            "attributes": {
                "name": "Teste",
                "color": "#15d3c9",
                "created": "2023-08-22T11:12:42.015-03:00",
                "modified": "2023-08-22T11:12:42.015-03:00"
            }
        },
        {
            "id": "b49a0311-403d-48cc-a269-b2c5ef948178",
            "type": "templates",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/templates/b49a0311-403d-48cc-a269-b2c5ef948178",
                "files": {
                    "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMTgvMTcvMjYvMDYvMmVjYmQ4YzAtNjg2My00MWYyLThiNmYtMmY2N2IzMDE1N2UxL2ZpbGUuZG9jeCJdXQ/file.docx?sha=ad2b4ab2df197db0"
                }
            },
            "attributes": {
                "name": "Template 1",
                "color": "#ff86d5",
                "created": "2023-08-18T14:26:06.610-03:00",
                "modified": "2023-08-18T14:26:06.610-03:00"
            }
        },
        {
            "id": "dd4b221a-a06a-4fec-ac31-358a822f9a51",
            "type": "templates",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/templates/dd4b221a-a06a-4fec-ac31-358a822f9a51",
                "files": {
                    "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMTgvMTcvMzkvMjMvYTczNjYxNWQtODA0Yy00MDRjLWE0M2EtMTEzNjU1NWRhYWRhL2ZpbGUuZG9jeCJdXQ/file.docx?sha=83af1577688ed584"
                }
            },
            "attributes": {
                "name": "Template 2",
                "color": "#15d3c9",
                "created": "2023-08-18T14:39:23.801-03:00",
                "modified": "2023-08-18T14:39:23.801-03:00"
            }
        },
        {
            "id": "ee72d863-304d-42f2-8d13-8acf83f069e2",
            "type": "templates",
            "links": {
                "self": "https://3.clicksign.dev/api/v3/templates/ee72d863-304d-42f2-8d13-8acf83f069e2",
                "files": {
                    "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMTgvMTcvNTcvMTMvNjBjMjcxNzEtZjNmNS00NTJkLTk5NWQtZWZlZDc3ODY1ZGFhL2ZpbGUuZG9jeCJdXQ/file.docx?sha=36ae6096ff746560"
                }
            },
            "attributes": {
                "name": "Template 3",
                "color": "#15d3c9",
                "created": "2023-08-18T14:57:13.217-03:00",
                "modified": "2023-08-18T14:57:13.217-03:00"
            }
        }
    ],
    "meta": {
        "record_count": 5
    },
    "links": {
        "first": "https://3.clicksign.dev/api/v3/templates?page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://3.clicksign.dev/api/v3/templates?page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}