Herald
OpenapiLegal

List the current effective agreements for a realm (Terms + Privacy).

Public — no `inject_identity`. Each agreement type resolves to its current effective version (realm custom if present, otherwise platform default); missing types are skipped. Returns 404 when no type resolves, which signals a seed-missing deployment anomaly (the platform default templates should always be present).

GET
/api/legal/{realmId}/agreements

Public — no inject_identity. Each agreement type resolves to its current effective version (realm custom if present, otherwise platform default); missing types are skipped. Returns 404 when no type resolves, which signals a seed-missing deployment anomaly (the platform default templates should always be present).

Path Parameters

realmId*string

Realm ID

Query Parameters

locale?string

Preferred locale for the returned body (falls back to default locale)

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/legal/string/agreements"
{  "agreements": [    {      "agreement_type": "string",      "effective_at": "2019-08-24T14:15:22Z",      "external_url": "string",      "mode": "full_text",      "summary": "string",      "title": "string",      "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",      "version_no": 0    }  ]}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}