# Modelo de carta

## List Models <a href="#list-models" id="list-models"></a>

Este endpoint lista os modelos de carta cadastrados na empresa.

<mark style="color:green;">`GET`</mark> \ <mark style="color:$primary;">**Url Produção:**</mark> `https://api.acessorh.com.br`\ <mark style="color:$primary;">**Url Homologação:**</mark> `https://api.rh.homolog.acesso.io`\ <mark style="color:$primary;">**Endpoint:**</mark> `/v1/models`

### **Headers**

| Key                                             | Type   | Description                                                  |
| ----------------------------------------------- | ------ | ------------------------------------------------------------ |
| Authorization<mark style="color:red;">\*</mark> | string | Token de acesso adquirido pela plataforma Identity (Bearer). |

### **Query Parameters**

| Key                                       | Type    | Description                                                                                                         |
| ----------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| account<mark style="color:red;">\*</mark> | string  | <p>UID da <a href="organizacao">empresa</a> onde os modelos estão cadastrados.<br>(Único parâmetro obrigatório)</p> |
| sort                                      | string  | Ordena os resultados dos modelos por "name" e "updated".                                                            |
| skip                                      | integer | Indica a quantidade de modelos que serão pulados(paginação)                                                         |
| limit                                     | integer | Limite de modelos que serão listados(paginação)                                                                     |

{% hint style="warning" %}
so não seja inserido os parâmetros `limit` e `skip` , os valores padrões serão, respectivamente, 1000 e 0.

O parâmetro `limit` tem o seu valor máximo como 1000.
{% endhint %}

### Exemplo de requisição com obrigatórios

```json

curl --location 'https://api.acessorh.com.br/v1/models?account=uid%20da%20empresa' \
--header 'Authorization: Bearer token de auth'
```

### Exemplo de requisição completo

```json

curl --location 'https://api.acessorh.com.br/v1/models?account=uid%20da%20empresa&sort=name&limit=1000&skip=0' \
--header 'Authorization: Bearer token de auth'
```

### Exemplo de response

{% code title="200 Cake successfully retrieved" overflow="wrap" %}

```json
[
    {
        "code": "",
        "context": "brazil",
        "id": "b61a61e0-3824-4f1c-8044-adae53cba91e",
        "name": "Modelo 1",
        "sendToSignature": false,
        "signatureRequired": false,
        "template": {
            "path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/model/template/67dbabcc-d04b-4e2b-b5b4-064507eb9111/67dbabcc-d04b-4e2b-b5b4-064507eb9111.html",
            "mime": "text/html",
            "size": 29085,
            "name": ""
        },
        "type": "b4b89b51-bfe8-42fb-938c-0223aa56fbf4",
        "typeName": "Nome do tipo de modelo"
    }
]
```

{% endcode %}