Audit Log & Project API
Access the audit log and project-level configuration (admin endpoints).
3 min read
Audit Log & Project API
Access administrative endpoints for retrieving audit logs and project-level information.
Audit Log
List Audit Log Entries
GET /api/v1/audit-log?action={action}&userId={userId}&since={timestamp}&limit=50
Retrieve audit log entries for the current project. The audit log tracks all significant actions performed by users and automated systems.
Note
This endpoint requires **admin** permission on the project. Non-admin API keys will receive a `403 Forbidden` response.
Query Parameters
actionstring
Filter by action type (e.g., `"entity.created"`, `"entity.updated"`, `"entity.deleted"`, `"integration.synced"`, `"member.invited"`).
userIdstring
Filter by the user who performed the action.
sincenumber
Unix timestamp (ms). Only return entries created after this time.
limitnumber
Maximum number of entries to return (max: 200).
Response
dataAuditLogEntry[]
Array of audit log entries, sorted by timestamp descending (newest first).
data[].idstring
Unique audit log entry identifier.
data[].actionstring
The action that was performed (e.g., `"entity.created"`, `"integration.synced"`).
data[].userIdstring
The ID of the user who performed the action, or `"system"` for automated actions.
data[].entityIdstring | null
The entity ID involved in the action, if applicable.
data[].metadataobject
Additional context about the action (varies by action type).
data[].timestampnumber
Unix timestamp (ms) when the action occurred.
totalnumber
Total number of entries matching the query (before pagination).
hasMoreboolean
Whether there are more entries beyond the current page.
Tip
Use the `since` parameter for incremental polling. Store the timestamp of the last entry you processed and pass it on subsequent requests to only fetch new entries.
Project
Get Project Info
GET /api/v1/project
Retrieve general information about the current project, including usage statistics.
Response
data.idstring
Unique project identifier.
data.namestring
Project display name.
data.slugstring
URL-safe project slug.
data.planstring
Current subscription plan: `"free"`, `"pro"`, `"team"`, or `"enterprise"`.
data.entityTypeCountnumber
Total number of entity types defined in the project.
data.entityCountnumber
Total number of entities across all entity types.
data.memberCountnumber
Number of team members with access to the project.
Warning
The project endpoint returns aggregate counts that may be slightly delayed (up to 60 seconds) due to caching. For real-time entity counts, use the [Entities API](/docs/api-entities) with pagination metadata.
Was this helpful?