List activities Retrieves a paginated, filterable list of activity log entries. Standard users see only their own activities. Admin users see all activities and can filter by user.
Maximum number of records to return. Defaults to 50.
Number of records to skip for pagination. Defaults to 0.
Admin only. When true, returns activities for all users.
Admin only. Filter activities to a specific user.
Optional filter criteria. Filter by activity category.
Filter by action performed.
ISO 8601 timestamp. Return activities created on or after this date.
ISO 8601 timestamp. Return activities created on or before this date.
Filter by the type of resource the activity relates to.
Filter by the ID of the resource the activity relates to.
Search term that matches against the activity title.
Common enum values The following tables list the most commonly used values for the filter and data fields. These are not exhaustive — custom values may appear as new features are added.
activity_type valuesValue Description genieActions related to genie (agent) management documentKnowledge base document operations userUser account and profile changes teamTeam membership and settings changes conversationConversation lifecycle events systemSystem-generated events (billing, maintenance, etc.)
action valuesValue Description createdA resource was created updatedA resource was modified deletedA resource was removed viewedA resource was accessed or opened exportedData was exported importedData was imported
category valuesValue Description agent_managementGenie creation, configuration, and deployment knowledge_managementDocument uploads, processing, and organization user_managementUser invitations, role changes, and profile updates team_managementTeam creation, member additions, and settings conversationConversation syncing, analysis, and review
const response = await ApiService . invoke ({ resource: "activities" , action: "all" , data: { limit: 20 , offset: 0 , filters: { category: "agent_management" , activityType: "genie" , action: "created" , startDate: "2025-01-01T00:00:00Z" , endDate: "2025-12-31T23:59:59Z" , searchTerm: "created" , }, }, });
Response Array of activity records. Unique activity identifier.
The type of activity (e.g., genie, document, system).
The action performed (e.g., created, updated, deleted).
Human-readable title describing the activity.
Activity category for grouping.
Detailed description of the activity.
The type of resource this activity relates to.
The ID of the related resource.
The name of the related resource.
Duration of the activity in milliseconds, if applicable.
Arbitrary metadata associated with the activity.
Session identifier for grouping related activities.
ID of the user who performed the activity.
Whether the activity is visible in the UI.
ISO 8601 timestamp of when the activity was created.
Total number of matching activities.
The limit that was applied.
The offset that was applied.
Get activity Retrieves a single activity record by ID. Standard users can only access their own activities.
const response = await ApiService . invoke ({ resource: "activities" , action: "get" , id: "activity-uuid" , });
Response Create activity Creates a new activity record. Restricted to admin users and service-role callers.
The action that was performed.
Human-readable title for the activity.
Type of the related resource.
ID of the related resource.
Name of the related resource.
Duration in milliseconds.
Session identifier for grouping.
User ID to attribute the activity to. Defaults to the authenticated user.
Whether the activity should be visible in the UI.
Only admin users (internal_* role) and service-role callers can create activities. Standard users receive a 403 FORBIDDEN error.
const response = await ApiService . invoke ({ resource: "activities" , action: "create" , data: { activity_type: "genie" , action: "created" , title: "New genie created: Sales Assistant" , resource_type: "agent" , resource_id: "agent-uuid" , resource_name: "Sales Assistant" , metadata: { voice_id: "voice-id" , }, }, });
Response (status 201) The newly created activity object.
Forbidden actions The update and delete actions are not permitted on activities. All callers — including admin users — receive a 403 FORBIDDEN error.
Update (forbidden)
Delete (forbidden)
// Returns 403 FORBIDDEN const response = await ApiService . invoke ({ resource: "activities" , action: "update" , id: "activity-uuid" , data: { title: "Updated title" }, });
Activity records are immutable once created. The update and delete actions return 403 FORBIDDEN for all callers, including admin users and service-role tokens. This is by design — audit logs must remain tamper-proof. If you need to correct an activity, create a new compensating entry instead.
