Skip to main content

Audit Log

GET/v1/orgs/{org_id}/audit

Query Audit Events

Query audit events for an organization.

Admin tokenscope: org:adminoperation_id: audit.listEvents

Authentication

Create via POST /v1/orgs/{org_id}/tokens/admin. Org-wide scope — keep tightly held.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Query parameters

NameTypeRequiredDescription
action#querystring | nulloptional
actor#querystring | nulloptional
since#querystring | nulloptional
until#querystring | nulloptional
limit#queryintegeroptional
offset#queryintegeroptional

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

idrequiredstring
actorrequiredstring
actionrequiredstring
resource_typerequiredstring | null
resource_idrequiredstring | null
metadatarequiredobject | null
signaturestring | null
prev_signaturestring | null
created_atrequiredstring

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have org access (wrong org_id, or insufficient role).
404Resource does not exist in this org.

Request

curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/audit' \
  -H 'Authorization: Bearer $ZNYX_TOKEN'

Response

application/json

Successful Response

[
  {
    "id": "string",
    "actor": "string",
    "action": "string",
    "resource_type": null,
    "resource_id": null,
    "metadata": null,
    "signature": null,
    "prev_signature": null,
    "created_at": "string"
  }
]

Schema: AuditEventResponse[]