Listar contratos
/v1/contractsContratos do merchant, do mais novo para o mais antigo, criados pela API ou pelo portal.
- Cada item é um resumo; signatários, tags e o resto do contrato estão em
GET /contracts/{id}. - Filtros:
statusecontractTemplateId. Valor fora do enum → 422VALIDATION.FAILED. - Sem
contracts:contracts:read→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth contracts:contracts: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:contracts:read
status?stringdraft só existe durante a emissão; signed, refused, expired e canceled são finais.
"draft""pending_signature""viewed""partially_signed""signed""refused""expired""canceled"contractTemplateId?stringlimit?integerTamanho da página, 1–100; fora → 422 VALIDATION.FAILED.
1 <= value <= 10020cursor?stringnextCursor da página anterior, com os mesmos filtros e o mesmo limit. Adulterado, de outra lista, de outro merchant ou com filtros diferentes → 422 CURSOR.INVALID.
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}$Página de contratos.
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/contracts?contractTemplateId=ctt_0192f3a0b1c24d3e8f9a0b1c2d3e4f50' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "ctr_0192f3c1a7b84e2d9f0a1b2c3d4e5f60", "status": "pending_signature", "name": "Locação Villa Trancoso 21–28/11", "description": null, "contractTemplateId": "ctt_0192f3a0b1c24d3e8f9a0b1c2d3e4f50", "signersExpected": 1, "signersSigned": 0, "expiresAt": "2026-11-27T15:00:00Z", "effectiveAt": null, "signedAt": null, "hasSignedFile": false, "createdAt": "2026-10-28T15:00:00Z" } ], "hasMore": false, "nextCursor": null}