Query Audit Events

Query audit events for an organization.

Bearer token or X-API-Keyscope: org memberoperation_id: audit.listEvents

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Admin token — create via POST /v1/orgs/{org_id}/tokens/admin. Org-wide scope, so keep it tightly held. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/audit?limit=50&offset=0" \
  -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,
    "signing_key_id": null,
    "created_at": "string"
  }
]

Schema: AuditEventResponse[]

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-

Query parameters

Name	Type	Required	Description
action#query	string \| null	optional	-
actor#query	string \| null	optional	-
since#query	string \| null	optional	-
until#query	string \| null	optional	-
limit#query	integer	optional	-
offset#query	integer	optional	-

Header parameters

Name	Type	Required	Description
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Responses

Status	Description
200	Successful Response
422	Validation Error

Response schema

idrequiredstring

actorrequiredstring

actionrequiredstring

resource_typerequiredstring | null

resource_idrequiredstring | null

metadatarequiredobject | null

signaturestring | null

prev_signaturestring | null

signing_key_idstring | null

created_atrequiredstring

Errors & what triggers them

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