Hivebrite by @altf1be
Full Hivebrite Admin API CLI covering users, companies, events, groups, donations, memberships, emailings, mentoring, news, projects, media center, forums, admins, approvals, roles, receipts, categories, comments, posts, audit logs, engagement scoring, payment accounts, network settings, and more.
Setup
- 1. Obtain API credentials from your Hivebrite admin panel (Settings > Integrations or API).
- Set environment variables (or create
.env in {baseDir}):
CODEBLOCK0
- 3. Install dependencies: INLINECODE2
API Info
- - Base URL:
{HIVEBRITE_BASE_URL}/api/admin/v2/ (some endpoints use v1 or v3) - Auth: OAuth2 (
grant_type=password or grant_type=refresh_token) or Bearer token - Pagination: RFC-5988 Link headers. Params:
page (default 1), per_page (default 25, max 100) - Rate limits: 300 requests/minute. Max 15 errors (5xx) per minute before throttling.
Commands
Me
CODEBLOCK1
Settings
CODEBLOCK2
Network
CODEBLOCK3
Users
CODEBLOCK4
Experiences (standalone)
CODEBLOCK5
Educations (standalone)
CODEBLOCK6
Emailings
CODEBLOCK7
Groups
CODEBLOCK8
Companies
CODEBLOCK9
News
CODEBLOCK10
Roles
CODEBLOCK11
Business Opportunities
CODEBLOCK12
Receipts
CODEBLOCK13
Pages (customizable)
CODEBLOCK14
Approvals
CODEBLOCK15
Versions (deleted items)
CODEBLOCK16
Comments (v3 API)
CODEBLOCK17
Posts (v3 API)
CODEBLOCK18
Events
CODEBLOCK19
Projects (Ventures)
CODEBLOCK20
Memberships
CODEBLOCK21
Engagement Scoring
CODEBLOCK22
Payment Accounts
CODEBLOCK23
Categories
CODEBLOCK24
Current Locations
CODEBLOCK25
Media Center
CODEBLOCK26
Audit Logs
CODEBLOCK27
Admins
CODEBLOCK28
Mentoring
CODEBLOCK29
Order Management (manual transactions)
CODEBLOCK30
Email Analytics
CODEBLOCK31
Forums
CODEBLOCK32
Notifications
CODEBLOCK33
Sub-Networks (clusters)
CODEBLOCK34
User Data Fields
CODEBLOCK35
Donations
CODEBLOCK36
Pagination (all list commands)
All list commands support pagination:
CODEBLOCK37
Security
- - Auth method: Bearer token or OAuth 2.0 with auto-refresh (password/refresh_token grant)
- No secrets or tokens printed to stdout
- All delete operations require explicit
--confirm flag - Built-in rate limiting with exponential backoff retry (3 attempts)
- OAuth tokens cached in INLINECODE9
- Lazy config validation (only checked when a command runs)
Dependencies
- -
commander — CLI framework - INLINECODE11 — environment variable loading
- Node.js built-in
fetch (requires Node >= 18)
Author
Abdelkrim BOUJRAF — ALT-F1 SRL, Brussels 🇧🇪 🇲🇦
X: @altf1be
Hivebrite by @altf1be
完整的Hivebrite管理API CLI,涵盖用户、公司、活动、群组、捐赠、会员、邮件、导师、新闻、项目、媒体中心、论坛、管理员、审批、角色、收据、分类、评论、帖子、审计日志、参与度评分、支付账户、网络设置等。
设置
- 1. 从Hivebrite管理面板获取API凭证(设置 > 集成或API)。
- 设置环境变量(或在{baseDir}中创建.env文件):
必填 — 您的Hivebrite实例URL
HIVEBRITE
BASEURL=https://yourcommunity.hivebrite.com
认证方式1:Bearer令牌(最简单)
HIVEBRITE
ACCESSTOKEN=your-access-token
认证方式2:OAuth2密码授权(需设置全部四项):
HIVEBRITECLIENTID=your-client-id
HIVEBRITECLIENTSECRET=your-client-secret
HIVEBRITEADMINEMAIL=admin@example.com
HIVEBRITEADMINPASSWORD=your-password
认证方式3:OAuth2刷新令牌授权(需设置全部三项):
HIVEBRITECLIENTID=your-client-id
HIVEBRITECLIENTSECRET=your-client-secret
HIVEBRITEREFRESHTOKEN=your-refresh-token
可选
HIVEBRITEMAXRESULTS=25
- 3. 安装依赖:cd {baseDir} && npm install
API信息
- - 基础URL: {HIVEBRITEBASEURL}/api/admin/v2/(部分端点使用v1或v3)
- 认证: OAuth2(granttype=password或granttype=refreshtoken)或Bearer令牌
- 分页: RFC-5988 Link头部。参数:page(默认1),perpage(默认25,最大100)
- 速率限制: 每分钟300次请求。节流前每分钟最多15个错误(5xx)。
命令
我的信息
bash
node {baseDir}/scripts/hivebrite.mjs me
设置
bash
node {baseDir}/scripts/hivebrite.mjs settings customizable-attributes
node {baseDir}/scripts/hivebrite.mjs settings fields-of-study
node {baseDir}/scripts/hivebrite.mjs settings industries
node {baseDir}/scripts/hivebrite.mjs settings job-functions
node {baseDir}/scripts/hivebrite.mjs settings currencies
网络
bash
node {baseDir}/scripts/hivebrite.mjs network info
node {baseDir}/scripts/hivebrite.mjs network sub-networks
node {baseDir}/scripts/hivebrite.mjs network citizenships
用户
bash
列出/搜索用户
node {baseDir}/scripts/hivebrite.mjs users list
node {baseDir}/scripts/hivebrite.mjs users list --query john
增删改查
node {baseDir}/scripts/hivebrite.mjs users read --id 123
node {baseDir}/scripts/hivebrite.mjs users create --email jane@example.com --firstname Jane --lastname Doe
node {baseDir}/scripts/hivebrite.mjs users update --id 123 --phone +1234567890
node {baseDir}/scripts/hivebrite.mjs users delete --id 123 --confirm
子资源
node {baseDir}/scripts/hivebrite.mjs users experiences --user-id 123
node {baseDir}/scripts/hivebrite.mjs users educations --user-id 123
node {baseDir}/scripts/hivebrite.mjs users notification-settings --user-id 123
node {baseDir}/scripts/hivebrite.mjs users postal-addresses --user-id 123
node {baseDir}/scripts/hivebrite.mjs users group-membership --user-id 123
特殊操作
node {baseDir}/scripts/hivebrite.mjs users find-by-field --field email --value jane@example.com
node {baseDir}/scripts/hivebrite.mjs users notify --id 123 --subject 你好 --message 欢迎!
node {baseDir}/scripts/hivebrite.mjs users activate --id 123
经历(独立)
bash
node {baseDir}/scripts/hivebrite.mjs experiences list
node {baseDir}/scripts/hivebrite.mjs experiences read --id 456
node {baseDir}/scripts/hivebrite.mjs experiences create --user-id 123 --title 工程师 --organization Acme
node {baseDir}/scripts/hivebrite.mjs experiences update --id 456 --title 高级工程师
node {baseDir}/scripts/hivebrite.mjs experiences delete --id 456 --confirm
node {baseDir}/scripts/hivebrite.mjs experiences customizable-attributes
教育经历(独立)
bash
node {baseDir}/scripts/hivebrite.mjs educations list
node {baseDir}/scripts/hivebrite.mjs educations read --id 789
node {baseDir}/scripts/hivebrite.mjs educations create --user-id 123 --degree 理学硕士 --school 麻省理工学院
node {baseDir}/scripts/hivebrite.mjs educations update --id 789 --field 计算机科学
node {baseDir}/scripts/hivebrite.mjs educations delete --id 789 --confirm
node {baseDir}/scripts/hivebrite.mjs educations customizable-attributes
邮件
bash
分类
node {baseDir}/scripts/hivebrite.mjs emailings categories list
node {baseDir}/scripts/hivebrite.mjs emailings categories read --id 10
node {baseDir}/scripts/hivebrite.mjs emailings categories create --name 新闻通讯
node {baseDir}/scripts/hivebrite.mjs emailings categories update --id 10 --name 月度新闻通讯
node {baseDir}/scripts/hivebrite.mjs emailings categories delete --id 10 --confirm
活动
node {baseDir}/scripts/hivebrite.mjs emailings campaigns list
node {baseDir}/scripts/hivebrite.mjs emailings campaigns read --id 20
node {baseDir}/scripts/hivebrite.mjs emailings campaigns create --subject 春季更新 --name 2026年春季
node {baseDir}/scripts/hivebrite.mjs emailings campaigns update --id 20 --subject 更新主题
node {baseDir}/scripts/hivebrite.mjs emailings campaigns delete --id 20 --confirm
node {baseDir}/scripts/hivebrite.mjs emailings campaigns send --id 20
群组
bash
群组增删改查
node {baseDir}/scripts/hivebrite.mjs groups list
node {baseDir}/scripts/hivebrite.mjs groups read --id 30
node {baseDir}/scripts/hivebrite.mjs groups create --name 巴黎校友
node {baseDir}/scripts/hivebrite.mjs groups update --id 30 --description 巴黎分会
node {baseDir}/scripts/hivebrite.mjs groups delete --id 30 --confirm
群组成员
node {baseDir}/scripts/hivebrite.mjs groups users list --group-id 30
node {baseDir}/scripts/hivebrite.mjs groups users add --group-id 30 --user-id 123
node {baseDir}/scripts/hivebrite.mjs groups users remove --group-id 30 --user-id 123 --confirm
话题分类
node {baseDir}/scripts/hivebrite.mjs groups topic-categories --group-id 30
公司
bash
node {baseDir}/scripts/hivebrite.mjs companies list
node {baseDir}/scripts/hivebrite.mjs companies list --query Acme
node {baseDir}/scripts/hivebrite.mjs companies read --id 40
node {baseDir}/scripts/hivebrite.mjs companies create --name Acme公司 --industry 科技
node {baseDir}/scripts/hivebrite.mjs companies update --id 40 --website https://acme.com
node {baseDir}/scripts/hivebrite.mjs companies delete --id 40 --confirm
新闻
bash
分类
node {baseDir}/scripts/hivebrite.mjs news categories list
node {baseDir}/scripts/hivebrite.mjs news categories read --id 50
node {baseDir}/scripts/hivebrite.mjs news categories create --name 公告
node {baseDir}/scripts/hivebrite.mjs news categories update --id 50 --name 官方新闻
node {baseDir}/scripts/hivebrite.mjs news