Guides
API reference
MCP server
Changelog
Write and destructive tools change your workspace. Clients that support it ask before they run.
List team members
heliyos_team_members_list · Read · Idempotent
Lists the workspace’s people: joined members and pending invitations, each with its membership_id, email, name, role (OWNER, ADMIN, MEMBER) and status (active, invited, declined or revoked). Filter by role or by text in the name or email. Returns structuredContent {members:[{membership_id, email, name, role, status}], total, next_cursor}.
Inputs
string
Only members with this role. One of
OWNER, ADMIN, MEMBER.string
Plain words matched against names and email addresses. Symbols such as + ( ) [ ] * ? can cause an error. Up to 200 characters.
integer
default:"20"
Members per page, 1 to 100. Default 20. From 1 to 100.
string
next_cursor from the previous page, with the same limit. Omit for the first page. Up to 200 characters.
string
default:"concise"
“concise” (default) returns one row per person; “detailed” returns user ids and invitation dates too. One of
concise, detailed.Returns
A readable text summary, plusstructuredContent with members, total, next_cursor.
API endpoints
- List roles ·
GET /v1/auth/roles - List team members ·
GET /v1/auth/team-memberships
Invite a team member
heliyos_team_members_invite · Write
Emails an invitation to join the workspace with the given role (ADMIN or MEMBER). A second invite to an email with a pending invitation fails with CONFLICT (resend it from Heliyos), so check heliyos_team_members_list first. Returns structuredContent {member} with the new membership_id and status invited.
Inputs
string
required
The person’s email address. Up to 320 characters.
string
required
ADMIN or MEMBER. OWNER cannot be granted with an API key; an owner does that in Heliyos Settings, Team. One of
OWNER, ADMIN, MEMBER.Returns
A readable text summary, plusstructuredContent with member.
API endpoints
- List roles ·
GET /v1/auth/roles - Invite a team member ·
POST /v1/auth/team-memberships
Remove a team member
heliyos_team_members_remove · Destructive · Idempotent
Removes a person from the workspace, or cancels a pending invitation, by membership_id (from heliyos_team_members_list). They lose access immediately. This cannot be undone (they would need a new invitation): confirm with the user first. The last owner cannot be removed. Returns structuredContent {membership_id, removed}.
Inputs
string
required
membership_id: a 24-character hex id. A 24-character hex id.
Returns
A readable text summary, plusstructuredContent with membership_id, removed.
API endpoints
- List roles ·
GET /v1/auth/roles - Remove a team member ·
DELETE /v1/auth/team-memberships/{id}
Change a team member’s role
heliyos_team_members_change_role · Write · Idempotent
Sets a team member’s role to ADMIN or MEMBER by membership_id (from heliyos_team_members_list). Owners’ roles and the OWNER role cannot be changed with an API key. Returns structuredContent {membership_id, role}.
Inputs
string
required
membership_id: a 24-character hex id. A 24-character hex id.
string
required
ADMIN or MEMBER. OWNER cannot be granted with an API key; an owner does that in Heliyos Settings, Team. One of
OWNER, ADMIN, MEMBER.Returns
A readable text summary, plusstructuredContent with membership_id, role.
API endpoints
- List roles ·
GET /v1/auth/roles - Change a team member role ·
PATCH /v1/auth/team-memberships/{id}/role