Skip to main content
The Audit Events API gives you read-only access to the complete activity log for your tenant. Every significant action in Synq — creating a product, updating settings, inviting a team member, connecting an integration — is written to this log automatically. You can query it to support compliance reviews, investigate incidents, or build custom monitoring dashboards. The audit log is immutable: you can query it, but you cannot modify or delete events.
All requests require three headers: Authorization: Bearer YOUR_TOKEN, X-Tenant-ID: YOUR_TENANT_ID, and X-Org-ID: YOUR_ORG_ID.

List audit events

Retrieve the most recent audit events for your tenant and organization, ordered by most recent first. Returns up to 50 events per request. GET /api/v1/audit

Headers

Authorization
string
required
Bearer token from your authentication provider.
X-Tenant-ID
string
required
UUID of your tenant.
X-Org-ID
string
required
UUID of your organization.

Response

Returns an array of audit event objects directly.
id
string
UUID of the audit event.
actor_email
string
Email or system identifier of the user or process that triggered the event.
action
string
The action that occurred. Common values include:
  • PRODUCT_CREATED
  • PRODUCT_UPDATED
  • PRODUCT_DELETED
  • INTEGRATION_CONNECTED
  • USER_INVITED
  • TENANT_SETTINGS_UPDATED
entity_type
string
The type of resource affected, e.g. PRODUCT, USER, COMMERCE_CONNECTION, TENANT_SETTINGS.
entity_id
string
UUID of the specific resource affected. May be empty if the entity does not yet have a persisted ID at the time of the event.
details
object
Free-form JSON object with additional context about the event.
ip_address
string
IP address from which the request originated.
created_at
string
ISO 8601 timestamp of when the event was recorded.
curl https://api.synq.app/api/v1/audit \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "X-Org-ID: YOUR_ORG_ID"
The audit log is read-only. There are no endpoints to create, update, or delete audit events. Events are written automatically by Synq whenever a significant action occurs.