email-templates

List

Templates visible to the caller: tenant admins see the system defaults plus their own tenant's overrides; platform admins see the system defaults plus ONE tenant's overrides — their own by default, tenant_id for another, or every tenant's with all_tenants=true. Filters only narrow that scope; total counts the rows matching every filter. Templates carry no locale, so there is no locale filter. Unknown format values match nothing; an unknown sort falls back to the default order (template_id A-Z, tenant override before the system default).

get/email-templates

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/email-templates
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

qstring

case-insensitive substring of template_id or subject

format'html' | 'text'

csv of body formats (OR)

sort'template' | 'subject' | 'created' | 'updated'

sort field; absent keeps the default order

sort_dir'asc' | 'desc'

sort direction (id breaks ties in the same direction)

limitinteger

page size

offsetinteger

page offset

tenant_idstring uuid

list this tenant instead of your own (default: the caller's own tenant, platform admins included). Another tenant requires the cross_tenant grant — 403 otherwise

all_tenantsboolean

list EVERY tenant (platform-wide admin view). Requires the cross_tenant grant — 403 otherwise. Mutually exclusive with tenant_id (400 conflicting_tenant_scope)

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.