POST https://api.helpgenie.ai/v1 with resource: "teams".
Access control
Access varies by action. Team owners and internal admins have full access to all actions. Team members with full access can also manage invitations, remove members and change member access. Members with limited access have read-only access to
get and members. Any authenticated user can create a team.Access levels
Every team member has ateam_access level:
Limited members also have a
team_permissions bitmask controlling what they may do inside their assigned views. Add the values together to combine permissions; null means all permissions.
For example,
5 (1 + 4) lets a limited member mark conversations as handled and reply, but not assign them. team_permissions is always null for full-access members.
Team management workflow
1
Create a team
Use the
create action to set up a new team. The authenticated user automatically becomes the team owner.2
Invite members
Use the
invite action to send invitations by email, choosing full or limited access. Track pending invitations with the invitations action.3
Members accept
Invited users accept the invitation with the
accept-invite action. Their profile is updated with the team_id and the access level set on the invitation.4
Manage the team
Use
members to view the roster, update-member-access to change what someone can see, remove-member to remove users, and cancel-invite to revoke pending invitations.List teams
Retrieves a paginated list of all teams across the platform, each with its owner profile and member count. Admin only.Get a team
Retrieves a specific team by ID with all team members.Response
Create a team
Creates a new team. The authenticated user automatically becomes the team owner.Response (status 201)
Update a team
Updates team settings such as name, brand, and branding.Response
Delete a team
Permanently deletes a team and removes all members.Response
List team members
Retrieves all members of a team.Response
Invite a member
Sends a team invitation to an email address. If a previous invitation exists for the same email, it is replaced. The invitee receives an email and must accept before joining. Invitations expire after 7 days. Returns400 if the person already belongs to a team.
Response (status 201)
List pending invitations
Retrieves all pending invitations for a team.Response
Cancel an invitation
Cancels a pending team invitation.Response
Resend an invitation
Resends a pending invitation, triggering a new invitation email to the invitee. The invitation is given a new ID (returned in the response) and its expiry is reset to 7 days; the old invitation ID stops working.Only invitations with
status: "pending" can be resent. Returns 404 if the invitation is not found, is no longer pending, or was already resent.Response
Remove a member
Removes a member from a team. The team owner cannot be removed. Removing a member also resets their access level and unassigns them from the team’s inbox views.Response
Update member access
Sets what a team member, or a pending invitation, can see: the whole workspace (full) or only the inbox views assigned to them (limited). Provide exactly one of memberId or invitationId.
The team owner always has full access and cannot be changed. You cannot change your own access; ask another full-access member.
Response
When updating a member: When updating an invitation:Accept an invitation
Accepts a pending team invitation for the signed-in account, using the invitation ID delivered in the invitation email. The invitation must be pending, unexpired, sent to the signed-in account’s email address and belong to the requested team.Response
Returns400 if the account already belongs to another team, and 404 if the invitation is missing, expired or was sent to another email address.

