Workspaces

A workspace is a shared space for a team or organization. Its members share the same data, and each member has a role in it. A user can belong to many workspaces and switches between them.

Create a workspace

Open Select workspace and use the + button, then give the workspace a name. You become its owner.

API: POST /v1/workspace.

Choose the workspace you work in

Open Select workspace, pick a workspace and confirm. Everything you do afterwards is done in that workspace. In API calls this is the X-TenantId header, and you must be a member of that workspace.

API: GET /v1/workspace/joined lists the workspaces you belong to.

Members

Open Workspace > Users to see the members and their roles.

Action API
List members GET /v1/workspace/{id}/users
Change a member's role POST /v1/workspace/{wsId}/user/{userId}/role
Block or unblock a member POST /v1/workspace/{wsId}/user/{userId}/block and .../unblock
Remove a member POST /v1/workspace/{wsId}/user/{userId}/remove
Leave a workspace POST /v1/workspace/leave

Owners and administrators manage members. A member with the workspace_admin role administers that workspace only.

Invite people

  1. Open Workspace > Invitations and add the person's email address.
  2. They receive an email and can accept from Workspace invitations on their account page.
  3. Pending invitations can be resent or revoked.

API: GET /v1/workspace/invite_user, POST /v1/workspace/add_user, GET /v1/workspace/{id}/invitations, POST /v1/workspace/{id}/invitations/{invitationId}/resend and .../revoke.

Join requests

A user can ask to join a workspace. Its administrators then approve or reject the request.

API: POST /v1/workspace/request_join, GET /v1/workspace/join_request/my, POST /v1/workspace/join_request/approve, POST /v1/workspace/join_request/reject.

Join automatically by email domain

A workspace can allow people whose email domain matches to join without an invitation. Turn it on from the workspace settings.

API: POST /v1/workspace/{id}/auto_join, GET /v1/workspace/auto_joinable.

Workspace details

You can change the workspace name and picture in Workspace > Details.

API: GET/PUT /v1/workspace/{id}, POST /v1/workspace/{id}/picture, DELETE /v1/workspace/{id}.

Membership

A workspace can have a paid membership. It belongs to the workspace, not to a single user, so everyone in the workspace shares it. See Workspace > Membership for the current plan.

API keys for a workspace

A workspace key lets a website or server act for the workspace without a person signing in. For example, it can add newsletter subscribers to the workspace.

  • Open Workspace > API Keys and choose a validity from 1 day to 2 years.
  • Up to 5 workspace keys per workspace.
  • Test a key with GET /v1/api_key/test.

See API keys for how to create, use, test and rotate them.