The Workspace API is in beta. Its endpoints and responses may change.
- Invite people to your workspace by email, one at a time or up to 50 at once.
- Resend pending invitations, including ones that expired.
- Create groups and choose the workspace role each group grants.
- Add and remove group members, up to 200 per request.
- List your groups and their members.
Prerequisites
- A personal access token for the workspace, with Full access. See Authentication to get one.
- The owner or admin role in the workspace. Editors can list groups and their members, but can’t change anything.
Workspace ID
Every endpoint takes your workspace’s ID in theworkspaceId query parameter. Use the workspace your personal access token belongs to. A token for another workspace is refused.
To get your workspace ID:
- Call Get app for any app in the workspace.
- Copy
organization_idfrom the response.
Groups and roles
Every member of a group gets the group’s role. Someone in several groups gets the highest of their roles, and a group with theno_access role blocks members who get their role only from it. When a member leaves their last group, they become a viewer, or get the workspace’s SSO default role when SSO is set up.
A group’s source tells you who manages it:
custom: Created in Base44. You can rename it, change its role, and change its members.idp: Synced from your identity provider. Its name and members come from your identity provider, so you can change only its role and description. Its role applies only while the workspace uses identity-provider groups.
group_id. They join the group when they accept.
Rate limits
Limits are counted per workspace, and every personal access token for the workspace shares one allowance.
Each invitation can also be resent 3 times every 10 minutes. If you exceed a limit, you get a
429 Too Many Requests response. Wait before retrying.