Settings and branding
The organization settings page, covering general details, company information, social links, finance defaults, email addresses, export formats, lifecycles, logo, colors and brand images.
Billing and usage
How an organization chooses a plan, pays through Stripe Checkout and the Stripe Customer Portal, and tracks metered usage, credits and limits on the Usage and Limits page.
Settings and branding
The organization settings page, covering general details, company information, social links, finance defaults, email addresses, export formats, lifecycles, logo, colors and brand images.
Billing and usage
How an organization chooses a plan, pays through Stripe Checkout and the Stripe Customer Portal, and tracks metered usage, credits and limits on the Usage and Limits page.
How to manage an organization's users, invitations, teams, roles and approval rules, and how built-in and custom roles grant permissions.
Access control decides who can open an organization and what they can do there. It lives in the sidebar under Organization, Access:
| Route | Purpose |
|---|---|
/{orgSlug}/users | Members tab with every user of the organization. |
/{orgSlug}/users/{userId} | One user's details, role and access. |
/{orgSlug}/users/invitations | Pending invitations tab. |
/{orgSlug}/users/invitations/create | Invite a user. |
/{orgSlug}/teams | Teams list. |
/{orgSlug}/teams/create | Create a team. |
/{orgSlug}/roles | Roles & Permissions, with the Roles tab. |
/{orgSlug}/roles/create | Create a custom role. |
/{orgSlug}/roles/approval-rules | Approval rules tab. See Approvals. |
Customer contacts who only use the customer portal are not users of the organization and do not appear here.
A user is a person with a role in the organization. Each user has exactly one organization role. Users can be disabled, which blocks their access without removing them, or removed from the organization.
A role is a set of permissions. Every organization has four built-in roles that cannot be edited or deleted:
| Role | Access |
|---|---|
| Owner | Everything an admin can do, plus billing, deleting the organization and transferring ownership. |
| Admin | Manage users, settings, roles and integrations. |
| Member | Standard write access to business data. |
| Viewer | Read-only access. |
You can add custom roles with any combination of organization permissions. Built-in roles show as Locked in the roles list.
Permissions follow the pattern organization.{feature}.{action}, for example organization.quotes.send. Most features have view, create, update and delete permissions, and some add their own actions. Every page of these docs lists the permissions it needs. See RBAC for how permissions are checked.
A team groups users who work together, such as Field Operations. Teams are used to assign work, share calendars and mention groups with @. Teams do not grant permissions. A team has a name, a slug, an icon and a description, and can be archived when it is no longer used.
An invitation asks someone to join the organization with a role. It is sent by email and is valid for seven days. Pending invitations can be edited, resent or revoked until they are accepted.
/{orgSlug}/users/invitations/create.The invitee opens the link at /invitations/{token}. They log in or create an account, and then join the organization with the chosen role. If they are signed in with a different email address, the page tells them to switch accounts. Expired, revoked and already accepted invitations show a clear message instead.
The Pending invitations tab lists email, role, sent date and expiry, with Active and Expired filters. Row actions are Open, Copy email, Resend invitation and Revoke invitation. Select several rows to revoke them together.
Open a user from the Members tab. On the detail page you can:
The Members tab can be searched and filtered by Access and Account status. Row actions are Open and Copy email.
Archive a team to hide it from active lists, or unarchive it to bring it back. Deleting a team is permanent. Both actions are available on the team page under Danger zone and as row and bulk actions in the list.
To change a custom role, open it from the list and edit its details or permissions. Delete a role from its row actions. Give its users and pending invitations another role first, because a role that is still assigned cannot be deleted.
| Permission | Allows |
|---|---|
organization.members.view | See users and invitations. |
organization.members.invite | Invite users and resend or revoke invitations. |
organization.members.update | Change roles, profile details and access. |
organization.members.remove | Remove users from the organization. |
organization.teams.view, .create, .update, .delete | Work with teams. |
organization.roles.view, .create, .update, .delete | Work with custom roles. |
organization.approvals.manage | Manage approval rules. |
The assistant can read teams, users, invitations, roles and permissions. It can also create and update teams, invite users, change roles, edit custom roles and set per-user permission overrides. Every change to access asks for approval first. See Chat.
All routes live under /api/v1/organizations/{organizationId}/:
| Method and path | Purpose |
|---|---|
GET members | List users. |
POST members | Invite a user. |
GET members/{userId} | Read one user. |
PATCH members/{userId} | Change a user's role. |
GET teams and POST teams | List and create teams. |
GET, PATCH and DELETE teams/{teamId} | Read, update and delete a team. |
PUT teams/{teamId}/members | Replace a team's members. |
GET invitations | List invitations. |
GET, PATCH and DELETE invitations/{invitationId} | Read, update and revoke an invitation. |
Not yet available: REST endpoints for roles and approval rules.
Last updated on
Settings and branding
The organization settings page, covering general details, company information, social links, finance defaults, email addresses, export formats, lifecycles, logo, colors and brand images.
Billing and usage
How an organization chooses a plan, pays through Stripe Checkout and the Stripe Customer Portal, and tracks metered usage, credits and limits on the Usage and Limits page.