Workspace Activity

Retrieve Workspace Activity

The activityList query provides access to a comprehensive activity feed for workspaces and organizations. Activities are automatically generated when users perform actions like creating todos, comments, or making workspace changes.

Basic Example

query ProjectActivity {
  activityList(
    projectId: "your-project-id"
    first: 20
    orderBy: createdAt_DESC
  ) {
    activities {
      id
      category
      html
      createdAt
      createdBy {
        id
        name
        email
      }
      project {
        id
        name
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

Advanced Example with Filtering

query FilteredActivity {
  activityList(
    companyId: "your-company-id"
    categories: [CREATE_TODO, MARK_TODO_AS_COMPLETE, CREATE_COMMENT]
    userIds: ["user1-id", "user2-id"]
    startDate: "2024-01-01T00:00:00Z"
    endDate: "2024-12-31T23:59:59Z"
    first: 50
    orderBy: createdAt_DESC
  ) {
    activities {
      id
      uid
      category
      html
      createdAt
      updatedAt
      createdBy {
        id
        name
        email
      }
      affectedBy {
        id
        name
      }
      todo {
        id
        title
      }
      comment {
        id
        text
      }
      project {
        id
        name
        slug
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Input Parameters

activityList Query

ActivityCategory Values

The system tracks various types of activities automatically:

ActivityOrderByInput Values

Response Fields

Activity Type

ActivityList Response

Real-Time Activity Updates

Subscribe to activity changes using the subscribeToActivity subscription:

subscription ActivityUpdates($companyId: String!, $projectId: String) {
  subscribeToActivity(companyId: $companyId, projectId: $projectId) {
    mutation
    node {
      id
      category
      html
      createdAt
      createdBy {
        id
        name
        email
      }
      project {
        id
        name
      }
    }
  }
}

Subscription Parameters

The subscription will notify you of:

• ACTIVITY_CREATED - New activities
• ACTIVITY_UPDATED - Modified activities
• ACTIVITY_DELETED - Removed activities

Filtering and Privacy

Automatic Filtering

The activity feed automatically filters results based on:

• Workspace Settings: Only shows activities from workspaces with activity tracking enabled
• User Permissions: Different user roles see different activity types
• Workspace Membership: Users only see activities from workspaces they have access to
• Organization Membership: Activities are scoped to the user’s organizations

Privacy Considerations

• CLIENT role users have limited visibility into certain administrative activities
• Activities respect workspace-level privacy settings
• Sensitive operations may not generate public activities

Error Responses

Invalid Workspace/Organization

{
  "errors": [{
    "message": "Project not found",
    "extensions": {
      "code": "NOT_FOUND"
    }
  }]
}

Permission Denied

{
  "errors": [{
    "message": "You do not have permission to view activities for this project",
    "extensions": {
      "code": "FORBIDDEN"
    }
  }]
}

Invalid Date Range

{
  "errors": [{
    "message": "Start date must be before end date",
    "extensions": {
      "code": "BAD_USER_INPUT"
    }
  }]
}

Best Practices

1. Use Pagination: Activity feeds can be large, always use first parameter
2. Filter by Workspace: Organization-wide activity feeds can be overwhelming
3. Real-time Updates: Use subscriptions for live activity feeds
4. Date Filtering: Use date ranges for historical activity analysis
5. Category Filtering: Filter by specific activity types for focused feeds
6. User Filtering: Track specific team members’ activities using userIds

Important Notes

• Activities are automatically generated and cannot be manually created via API
• Activity text uses HTML formatting for rich display
• The text field is deprecated in favor of html
• Activities are permanently stored and provide a complete audit trail
• Real-time subscriptions require WebSocket connection authentication