Groups
Collaborate with your team through shared resources and billing
A group is a team of users who share access to resources and can optionally share a billing destination. Groups let you collaborate without duplicating identities, presets, projects, or categories across accounts.
Every group has a unique name (case-insensitive) and at least one member. The user who creates a group becomes its owner automatically.
Roles
Each membership has a role that determines what the user can do within the group.
| Role | Capabilities |
|---|---|
owner | Full control: invite and remove members, change roles, delete the group, manage group billing |
admin | Invite and remove members |
member | Access resources shared with the group |
Each group has exactly one owner. Promoting another member to owner automatically demotes the current owner to admin.
Creating a group
Call the create endpoint with a unique group name. You become the owner.
Non-enterprise accounts can create a limited number of groups. Once the cap is reached, the create endpoint returns 403.
Inviting members
Owners and admins can invite users by email. The invitee receives an email containing a join link with a time-limited token. Invitations can optionally request a billing change, prompting the invitee to set the group as their billing destination when they accept.
Joining a group
The invitee accepts the invitation by calling the join endpoint with the token from the email. The request is idempotent: joining a group you already belong to returns success without creating a duplicate membership.
An invitation is bound to the email it was sent to. Accepting from a different account is rejected.
Shared resources
Groups are the unit of sharing across the platform. When you share a resource with a group, every member gains read access to it.
The following resources support group-based sharing:
- Identities: share with one or more groups via the identity share endpoint.
- Presets: share with one or more groups via the preset share endpoint.
- Preset categories: inherit visibility from the presets they contain and can be shared with groups.
- Projects: list endpoints can include projects created by members of your groups.
Unsharing a resource from a group removes access for all its members.
Shared billing
Members can route their usage to a group instead of their own account by setting the group as their billing destination. When they do, credits for their jobs are charged to the group owner rather than the individual member.
See Credits for the full billing model.
Group owners cannot set their own billing destination to a group they own. If you currently bill to a group, you must reset your billing destination before creating a new group.
Removing members and deleting groups
- Owners can remove any member, change any member's role, and delete the group.
- Admins can invite and remove members but cannot change roles or delete the group.
- Members cannot remove other members.
- A user cannot change their own role.
When a group is deleted, all memberships are removed and any member who was billing to that group has their billing destination reset to their own account.
API endpoints
Create a new group POST
/groupsList my groups GET
/groupsList group members GET
/groups/{group_name}/membersList grouped teammates for the current user. GET
/groups/membersInvite user to group POST
/groups/{group_name}/invitationsJoin group POST
/groups/joinUpdate member role PATCH
/groups/{group_name}/members/{user_email}/roleRemove member from group / Leave group DELETE
/groups/{group_name}/members/{user_email}Delete group DELETE
/groups/{group_name}