Skip to main content
Team members are the users of a workspace. Each one carries an organization role, which decides what they can see and change. For fields and response details, see the API reference.
A team member is addressed by its record id, a UUID returned by team-members list. The same value is what project-users create --user-id expects. Only active members resolve: a member removed with team-members delete is no longer found by show, update, or delete.
Sample responses on this page show the JSON envelope (--json). Pretty output is the default on a terminal and its columns adapt to width. See Output formats.

team-members list

List the active members of the workspace. Use it to find a member’s id, or to check who already has access before inviting someone.
--email matches one address exactly; it does not search by partial address. Results are paginated. --page-size defaults to 0, which sends no page size and lets the API return 30 per page; the maximum is 100.
The API reads the page number from page_number, while this release of the CLI sends page, so --page has no effect yet. --page-size works as described.

team-members show

Show one member: email, name, time zone, role, and whether they are active.

Required arguments

  • <id> - the team member’s record ID, from team-members list.

team-members create

Invite one or more people by email and give them an organization role. --email is repeatable. --role must name a role that exists on the workspace’s Roles page, and the value is case sensitive.
Every invitee gets an invitation email unless you pass --send-invitation-email=false. --invited-by is the email of the admin the invitation is sent from; it defaults to the workspace’s most recently added admin.
The response confirms the request and does not include the new member records. Run team-members list --email <address> afterwards to get an id.

team-members update

Change a member’s email, name, time zone, or role. Only the flags you pass are changed, and at least one is required.

Required arguments

  • <id> - the team member’s record ID, from team-members list.

team-members delete

Remove a member from the workspace. The member is deactivated rather than erased.

Required arguments

  • <id> - the team member’s record ID, from team-members list.
With --quiet the command prints success.