Filtrar Modelo por nome

👍
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 a filtragem por nome de Modelo na Clicksign. Esta é uma requisição GET para /api/v3/templates?filter[name]=, sendo necessário adicionar ao final desse endereço o termo a ser pesquisado, conforme exemplo abaixo. Não é necessário enviar atributos no body dessa requisição.

GET /api/v3/templates?filter[name]= HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

❗️
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?filter[name]=Template 3 HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Response

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

{
    "data": [
        {
            "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": 1
    },
    "links": {
        "first": "https://3.clicksign.dev/api/v3/templates?filter%5Bname%5D=Template+3&page%5Bnumber%5D=1&page%5Bsize%5D=20",
        "last": "https://3.clicksign.dev/api/v3/templates?filter%5Bname%5D=Template+3&page%5Bnumber%5D=1&page%5Bsize%5D=20"
    }
}