---
title: "GET /template-catalog"
description: "Modelos oficiais, plataformas e capacidades — parâmetros, schemas e exemplos completos."
sidebar:
  hidden: true
---

**Modelos oficiais, plataformas e capacidades.** Contrato v1 · disponível em produção e homologação · operação `getTemplateCatalog`. [Guia funcional](/produto/templates/) · [Índice](/api/operacoes/) · [Schemas](/referencia/) · [Testar em sandbox](/console/?operation=getTemplateCatalog).

## Autenticação e efeito

Permissão: `templates:read`. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a `app_loja`; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

Consulta não altera o recurso. Downloads revalidam autorização e têm prazo/estado conforme o guia.

## Parâmetros

| Nome | Local | Obrigatório | Tipo e restrições |
| --- | --- | --- | --- |
| `appId` | query | sim |  AppId; {"type":"string","maxLength":200,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._~-]*$"} |



## Corpo e semântica

Sem corpo. Envie os parâmetros na URL e os headers indicados.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. `null` só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.




## cURL

`AGILINK_API_KEY` deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

```sh
curl --request GET 'https://api.staging.agilink.io/v1/template-catalog?appId=app_loja' \
  --header 'Authorization: Bearer <credencial>'
```

## JavaScript / TypeScript

```js
// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/template-catalog?appId=app_loja', {
  method: 'GET',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`
},
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);
```

## Python

```python
# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"]
}
response = requests.request(
    'GET', 'https://api.staging.agilink.io/v1/template-catalog?appId=app_loja',
    headers=headers,
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)
```

## Response 200

Sucesso. Exemplo fictício.

| Header | Significado | Exemplo |
| --- | --- | --- |
| `X-Request-Id` | Identificador gerado pelo servidor, inclusive para falhas e replays. | conforme resposta |
| `Cache-Control` | Respostas administrativas não podem ser armazenadas. | no-store, no-transform |

```json
{
  "data": [
    {
      "id": "android",
      "rendererContractVersion": 1,
      "states": [
        "manual",
        "opening",
        "fallback"
      ],
      "actions": [
        "open-app",
        "open-browser"
      ],
      "nativeVariables": [
        "link.titulo",
        "link.descricao",
        "app.nome"
      ],
      "themes": {
        "light": {
          "background": "#f8fafc",
          "surface": "#ffffff",
          "border": "#e2e8f0",
          "text": "#0f172a",
          "muted": "#64748b",
          "accent": "#0284c7",
          "secondary": "#059669",
          "tertiary": "#f1f5f9"
        },
        "dark": {
          "background": "#0c0d0e",
          "surface": "#141517",
          "border": "#26272b",
          "text": "#f4f4f5",
          "muted": "#a1a1aa",
          "accent": "#0284c7",
          "secondary": "#10b981",
          "tertiary": "#1c1d20"
        }
      }
    },
    {
      "id": "ios",
      "rendererContractVersion": 1,
      "states": [
        "opening",
        "fallback"
      ],
      "actions": [
        "open-app",
        "install",
        "open-browser"
      ],
      "nativeVariables": [
        "link.titulo",
        "link.descricao",
        "app.nome"
      ],
      "themes": {
        "light": {
          "background": "#f8fafc",
          "surface": "#ffffff",
          "border": "#e2e8f0",
          "text": "#0f172a",
          "muted": "#64748b",
          "accent": "#0284c7",
          "secondary": "#0f172a",
          "tertiary": "#f1f5f9"
        },
        "dark": {
          "background": "#0c0d0e",
          "surface": "#141517",
          "border": "#26272b",
          "text": "#f4f4f5",
          "muted": "#a1a1aa",
          "accent": "#0284c7",
          "secondary": "#27272a",
          "tertiary": "#1c1d20"
        }
      }
    },
    {
      "id": "recovery",
      "rendererContractVersion": 1,
      "states": [
        "copy-only",
        "default",
        "copied",
        "manual",
        "fallback"
      ],
      "actions": [
        "copy-install",
        "install",
        "open-app",
        "copy-clip"
      ],
      "nativeVariables": [
        "link.titulo",
        "link.descricao",
        "app.nome"
      ],
      "themes": {
        "light": {
          "background": "#f8fafc",
          "surface": "#ffffff",
          "border": "#e2e8f0",
          "text": "#0f172a",
          "muted": "#64748b",
          "accent": "#0284c7",
          "secondary": "#059669",
          "tertiary": "#f1f5f9"
        },
        "dark": {
          "background": "#0c0d0e",
          "surface": "#141517",
          "border": "#26272b",
          "text": "#f4f4f5",
          "muted": "#a1a1aa",
          "accent": "#0284c7",
          "secondary": "#10b981",
          "tertiary": "#1c1d20"
        }
      }
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}
```

| Campo | Tipo | Obrigatório | Significado e limites |
| --- | --- | --- | --- |
| `data` | array | sim | Resultado tipado da operação. Até 100 itens |
| `data[].id` | android / ios / recovery | sim | Identificador estável do recurso.  |
| `data[].rendererContractVersion` | objeto | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data[].states` | array | sim | Valor tipado; formato e restrições completos no schema abaixo. Até 100 itens |
| `data[].actions` | array | sim | Valor tipado; formato e restrições completos no schema abaixo. Até 100 itens |
| `data[].nativeVariables` | array | sim | Valor tipado; formato e restrições completos no schema abaixo. Até 100 itens |
| `data[].themes` | object | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `pagination` | Pagination | sim | Continuação da lista; não é snapshot.  |
| `pagination.nextCursor` | Cursor ou null | sim | Cursor assinado; conserve filtros, credencial e limite.  |
| `pagination.hasMore` | boolean | sim | Indica se há continuação.  |
| `meta` | Meta | sim | Correlação e informações da resposta.  |
| `meta.requestId` | RequestId | sim | Identificador de correlação gerado pelo servidor.  |

## Falhas, revisão e repetição

Respeite Retry-After quando existir. Leituras podem ser repetidas após falhas transitórias. Não faça retry automático ilimitado.

| Status | Significado |
| --- | --- |
| 400 | Cabeçalho, query, cursor ou JSON inválido. |
| 401 | Credencial inválida, expirada ou revogada. |
| 403 | Operação sem permissão ou capacidade desabilitada. |
| 404 | Recurso inexistente ou fora dos aplicativos autorizados. |
| 422 | JSON bem formado com dados de domínio inválidos. |
| 429 | Quota excedida. Respeitar Retry-After. |
| 500 | Falha interna. Use requestId para diagnóstico. |
| 503 | Dependência indisponível; resultado da mutação pode ser incerto. |

### Exemplo 401

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}
```

### Exemplo 403

```json
{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}
```

### Exemplo 429

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}
```

## Schema completo e próximos passos

<details><summary>Schema de request</summary>

```json
{
  "description": "Sem corpo"
}
```

</details>

<details><summary>Schema de response</summary>

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateCatalogItem"
      },
      "maxItems": 100
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  },
  "required": [
    "data",
    "pagination",
    "meta"
  ]
}
```

</details>

[Convenções e limites](/api/contratos/) · [Erros](/api/errors/) · [Receitas completas](/receitas/) · [Guia funcional](/produto/templates/).