Listar modelos de contrato
/v1/contract-templatesModelos (.docx com tags) ativos do merchant, criados no portal ou pela API, do mais novo para o mais antigo.
- Lista curta, numa página só:
hasMoreé semprefalseenextCursor,null. isReadyToIssue: false→ o modelo ainda não pode emitir contrato (CONTRACT.TEMPLATE_NOT_READY).- Sem
contracts:templates:read→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth contracts:templates:readAuthorizationBearer <token>Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.
- Sandbox:
https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token - Produção:
https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token
Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.
O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.
Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.
Scope: contracts:templates:read
X-Merchant-Id*stringMerchant da operação (mrc_ + Guid sem hífens, minúsculo). Obrigatório com credencial de organização (ausente → 400 MERCHANT.HEADER_REQUIRED); com credencial de merchant é opcional (ausente = o próprio merchant). Malformado, repetido, inexistente ou de outro tenant → 403 MERCHANT.FORBIDDEN (nunca 404). Vazio = ausente.
^mrc_[0-9a-f]{32}$X-Correlation-Id?stringOpcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.
^[A-Za-z0-9._-]{1,64}$Modelos.
application/json- response
Envelope de toda lista. Cada domínio fixa o tipo dos itens de data.
data*array<>Itens no mesmo formato do GET do recurso.
hasMore*booleanHá página seguinte.
nextCursor*|Cursor opaco da página seguinte; null quando hasMore é false.
curl -X GET 'https://api.sandbox.kodano.com.br/v1/contract-templates' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "ctt_0192f3a0b1c24d3e8f9a0b1c2d3e4f50", "name": "Contrato de locação por temporada", "description": null, "isReadyToIssue": true, "tags": [ { "tag": "imovel", "label": "Imóvel", "inputType": "text", "requiredForSigner": false }, { "tag": "inicio", "label": "Início", "inputType": "date", "requiredForSigner": false } ], "createdAt": "2026-10-20T12:00:00Z", "updatedAt": "2026-10-20T12:00:00Z" } ], "hasMore": false, "nextCursor": null}