Activities

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.

string

required

activities

string

required

all

object

Show properties

number

Maximum number of records to return. Defaults to 50.

number

Number of records to skip for pagination. Defaults to 0.

boolean

Admin only. When true, returns activities for all users.

string

Admin only. Filter activities to a specific user.

object

Optional filter criteria.

Show properties

string

Filter by activity category.

string

Filter by activity type.

string

Filter by action performed.

string[]

Array of action values to exclude from results (e.g. ["viewed"]).

string

ISO 8601 timestamp. Return activities created on or after this date.

string

ISO 8601 timestamp. Return activities created on or before this date.

string

Filter by the type of resource the activity relates to.

string

Filter by the ID of the resource the activity relates to.

string

Search term. Matches against the activity title, description, and resource name.

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 values

Value	Description
`genie`	Actions related to genie (agent) management
`document`	Knowledge base document operations
`user`	User account and profile changes
`team`	Team membership and settings changes
`conversation`	Conversation lifecycle events
`system`	System-generated events (billing, maintenance, etc.)

action values

Value	Description
`created`	A resource was created
`updated`	A resource was modified
`deleted`	A resource was removed
`viewed`	A resource was accessed or opened
`exported`	Data was exported
`imported`	Data was imported

category values

Value	Description
`agent_management`	Genie creation, configuration, and deployment
`knowledge_management`	Document uploads, processing, and organization
`user_management`	User invitations, role changes, and profile updates
`team_management`	Team creation, member additions, and settings
`conversation`	Conversation 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",
    },
  },
});

curl -X POST https://api.helpgenie.ai/v1/activities \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
      }
    }
  }'

Response

Activity[]

Array of activity records.

Show Activity object

string

Unique activity identifier.

string

The type of activity (e.g., genie, document, system).

string

The action performed (e.g., created, updated, deleted).

string

Human-readable title describing the activity.

string | null

Activity category for grouping.

string | null

Detailed description of the activity.

string | null

Activity status.

string | null

Activity priority level.

string | null

The type of resource this activity relates to.

string | null

The ID of the related resource.

string | null

The name of the related resource.

number | null

Duration of the activity in milliseconds, if applicable.

object | null

Arbitrary metadata associated with the activity.

string | null

Session identifier for grouping related activities.

string | null

ID of the user who performed the activity.

boolean | null

Whether the activity is visible in the UI.

string

ISO 8601 timestamp of when the activity was created.

number

Total number of matching activities.

number

The limit that was applied.

number

The offset that was applied.

Get activity

Retrieves a single activity record by ID. Standard users can only access their own activities.

string

required

activities

string

required

get

string

required

The activity ID.

const response = await ApiService.invoke({
  resource: "activities",
  action: "get",
  id: "activity-uuid",
});

Response

Activity

The requested activity object. See Activity object for field details.

Create activity

Creates a new activity record. Restricted to admin users and service-role callers.

string

required

activities

string

required

create

object

required

Show properties

string

required

The type of activity.

string

required

The action that was performed.

string

required

Human-readable title for the activity.

string

Activity category.

string

Detailed description.

string

Activity status.

string

Priority level.

string

Type of the related resource.

string

ID of the related resource.

string

Name of the related resource.

number

Duration in milliseconds.

object

Arbitrary metadata.

string

Session identifier for grouping.

string

User ID to attribute the activity to. Defaults to the authenticated user.

boolean

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)

Activity

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.

// Returns 403 FORBIDDEN
const response = await ApiService.invoke({
  resource: "activities",
  action: "update",
  id: "activity-uuid",
  data: { title: "Updated title" },
});

// Returns 403 FORBIDDEN
const response = await ApiService.invoke({
  resource: "activities",
  action: "delete",
  id: "activity-uuid",
});

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.

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

List activities

Common enum values

Response

Get activity

Response

Create activity

Response (status 201)

Forbidden actions

​List activities

​Common enum values

​Response

​Get activity

​Response

​Create activity

​Response (status 201)

​Forbidden actions

List activities

Common enum values

Response

Get activity

Response

Create activity

Response (status 201)

Forbidden actions