terms

List

Every terms document row the caller may read (tenant admin: their tenant's + global; platform admin: global + their own tenant's by default, tenant_id for another, all_tenants=true for every tenant), including inactive and expired versions — this is the admin history view, not the "what applies right now" view (that's getMyTerms). Filters only narrow that scope; total counts the rows matching every filter. status is derived at request time from is_active and the effective/expiry window (in_force = active, effective and unexpired; scheduled = active, effective_at in the future; expired = active, expires_at passed; inactive = retired). from/to bound effective_at: YYYY-MM-DD is an inclusive whole UTC day, RFC3339 an exact instant (from inclusive, to exclusive); malformed is 400 invalid_from / invalid_to. Unknown status/type values match nothing; an unknown sort falls back to effective.

get/terms

Request

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

Query parameters

qstring

case-insensitive substring of title, version or summary

status'in_force' | 'scheduled' | 'expired' | 'inactive'

csv of lifecycle statuses (OR)

type'platform' | 'privacy' | 'cookies' | 'aml' | 'custom'

csv of document types (OR)

fromstring

effective_at lower bound (inclusive): YYYY-MM-DD or RFC3339

tostring

effective_at upper bound: YYYY-MM-DD (inclusive day) or RFC3339 (exclusive)

sort'effective' | 'created' | 'updated' | 'title' | 'type' | 'version'

sort field

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.