Skip to main content
All requests use a single endpoint: 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.
Only team owners, full-access members and internal admins can manage invitations, remove members and change member access. Limited members have read-only access to get and members only.

Access levels

Every team member has a team_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.
string
required
Must be "teams"
string
required
Must be "list"
object
boolean
object

Get a team

Retrieves a specific team by ID with all team members.
string
required
Must be "teams"
string
required
Must be "get"
string
required
The team ID.

Response

boolean
object

Create a team

Creates a new team. The authenticated user automatically becomes the team owner.
string
required
Must be "teams"
string
required
Must be "create"
object
required

Response (status 201)

boolean
object

Update a team

Updates team settings such as name, brand, and branding.
string
required
Must be "teams"
string
required
Must be "update"
string
required
The team ID.
object
required

Response

boolean
object

Delete a team

Permanently deletes a team and removes all members.
string
required
Must be "teams"
string
required
Must be "delete"
string
required
The team ID.

Response

boolean
object
This permanently deletes the team and removes all member associations.

List team members

Retrieves all members of a team.
string
required
Must be "teams"
string
required
Must be "members"
string
required
The team ID.

Response

boolean
object

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. Returns 400 if the person already belongs to a team.
string
required
Must be "teams"
string
required
Must be "invite"
string
required
The team ID.
object
required

Response (status 201)

boolean
object

List pending invitations

Retrieves all pending invitations for a team.
string
required
Must be "teams"
string
required
Must be "invitations"
string
required
The team ID.

Response

boolean
object

Cancel an invitation

Cancels a pending team invitation.
string
required
Must be "teams"
string
required
Must be "cancel-invite"
string
required
The invitation UUID.
object
required

Response

boolean
object

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.
string
required
Must be "teams"
string
required
Must be "resend-invite"
string
required
The invitation UUID to resend.
object
required
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

boolean
object

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.
string
required
Must be "teams"
string
required
Must be "remove-member"
string
required
The team ID.
object
required

Response

boolean
object

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.
string
required
Must be "teams"
string
required
Must be "update-member-access"
string
required
The team ID.
object
required

Response

When updating a member:
boolean
object
When updating an invitation:
boolean
object

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.
This action only works from the invited person’s own signed-in session. API keys and impersonated sessions are rejected with 403.
string
required
Must be "teams"
string
required
Must be "accept-invite"
string
required
The team ID.
object
required

Response

boolean
object
Returns 400 if the account already belongs to another team, and 404 if the invitation is missing, expired or was sent to another email address.

Branding actions

get-branding

Returns the team’s branding configuration. Parameters — none (uses the authenticated user’s team).

update-branding

Updates the team’s branding (colors, logo, gradient settings). Team owner or admin only. Parameters

clear-branding

Resets all branding fields to null. Team owner or admin only. Parameters — none.

Genie sharing actions

share-genie

Shares a Genie with every member of the team. Members who already have access keep their existing grant, and the Genie owner is skipped. Parameters

grant-genie-access

Grants a team member access to a specific Genie. Parameters

remove-genie-access

Revokes a team member’s access to a specific Genie. Parameters

Error responses