excalidraw workspace
View and administer the current workspace.
Manage workspace metadata, users, and invites for the API key's workspace.
excalidraw workspace [options] [command]| Command | Description |
|---|---|
get | Show current workspace metadata. |
update | Update workspace metadata. |
users | List, inspect, update, or remove workspace users. |
invites | Manage email invites and invite links. |
Examples
excalidraw workspace get
excalidraw workspace users list --limit 50
excalidraw workspace invites create --email teammate@example.com --role member
excalidraw workspace invites create-link --role member --max-uses 10Notes
- All workspace commands operate on the workspace associated with the API key.
get
Return workspace metadata, including its name, picture, subscription status, and user IDs.
excalidraw workspace get [options]Examples
excalidraw workspace getupdate
Rename the workspace or change its picture.
excalidraw workspace update [options]| Option | Description |
|---|---|
--name <name> | New workspace name. |
--picture <url> | New workspace picture URL, or none to remove it. |
Examples
excalidraw workspace update --name "Design team"
excalidraw workspace update --picture https://example.com/workspace.png
excalidraw workspace update --picture noneNotes
- Provide at least one field to update. Omitted fields stay unchanged.
users
Manage users who currently have access to the workspace.
excalidraw workspace users [options] [command]| Command | Description |
|---|---|
list | List workspace users. |
get | Show one workspace user. |
update | Update a workspace user. |
remove | Remove a user from the workspace. |
Examples
excalidraw workspace users list --limit 50
excalidraw workspace users get <userId>
excalidraw workspace users update <userId> --role admin
excalidraw workspace users remove <userId>users list
Return users in the current workspace with their workspace roles.
excalidraw workspace users list [options]| Option | Description |
|---|---|
--limit <number> | Maximum number of users to return, from 1 to 100; default 5. |
--offset <number> | Number of users to skip for offset pagination. |
--all | Fetch every page and print one combined list; --limit sets the page size. |
Examples
excalidraw workspace users list
excalidraw workspace users list --limit 100
excalidraw workspace users list --all --output tableNotes
- Use this to discover user IDs before role updates or removals.
- With
--allthe output is { count, data } instead of a single page with hasNextPage.
users get
Get profile metadata and workspace role for a specific user.
excalidraw workspace users get [options] <userId>| Argument | Description |
|---|---|
<userId> | Workspace user ID. |
Examples
excalidraw workspace users get <userId>users update
Update a user's display metadata or workspace role.
excalidraw workspace users update [options] <userId>| Argument | Description |
|---|---|
<userId> | Workspace user ID to update. |
| Option | Description |
|---|---|
--name <name> | New user display name. |
--picture <url> | New user picture URL, or none to remove it. |
--role <role> | Workspace role to assign: member or admin. |
Examples
excalidraw workspace users update <userId> --role admin
excalidraw workspace users update <userId> --name "Ada Lovelace"
excalidraw workspace users update <userId> --picture noneNotes
- Email updates are not supported by the public API.
- Downgrading the sole workspace admin fails.
users remove
Revoke a user's access to the current workspace.
excalidraw workspace users remove [options] <userId>| Argument | Description |
|---|---|
<userId> | Workspace user ID to remove. |
Examples
excalidraw workspace users remove <userId>Notes
- Removing a user revokes workspace access, workspace/team membership, permissions, and that user's API keys for this workspace.
- It does not delete the global user account. Removing the sole workspace admin fails.
invites
Create, inspect, update, and revoke workspace invites.
excalidraw workspace invites [options] [command]| Command | Description |
|---|---|
list | List workspace invites. |
get | Show one workspace invite. |
create | Create an email invite. |
create-link | Create an invite link. |
update | Update a workspace invite. |
delete | Revoke a workspace invite. |
Examples
excalidraw workspace invites list --limit 50
excalidraw workspace invites create --email teammate@example.com --role member
excalidraw workspace invites create-link --role admin --max-uses 1
excalidraw workspace invites delete <inviteId>invites list
Return pending and active invites for the current workspace.
excalidraw workspace invites list [options]| Option | Description |
|---|---|
--limit <number> | Maximum number of invites to return, from 1 to 100; default 5. |
--offset <number> | Number of invites to skip for offset pagination. |
--all | Fetch every page and print one combined list; --limit sets the page size. |
Examples
excalidraw workspace invites list
excalidraw workspace invites list --limit 100
excalidraw workspace invites list --all --output tableNotes
- Use this to discover invite IDs before updating or revoking invites.
- With
--allthe output is { count, data } instead of a single page with hasNextPage.
invites get
Get status, role, usage limits, and metadata for a workspace invite.
excalidraw workspace invites get [options] <inviteId>| Argument | Description |
|---|---|
<inviteId> | Workspace invite ID. |
Examples
excalidraw workspace invites get <inviteId>invites create
Invite one email address to join the workspace with a member or admin role.
excalidraw workspace invites create [options]| Option | Description |
|---|---|
--email <email> | Email address to invite. Required. |
--role <role> | Workspace role to grant: member or admin. Required. |
Examples
excalidraw workspace invites create --email teammate@example.com --role member
excalidraw workspace invites create --email lead@example.com --role admininvites create-link
Create a workspace invite link that can be redeemed a set number of times.
excalidraw workspace invites create-link [options]| Option | Description |
|---|---|
--role <role> | Workspace role granted by the link: member or admin. Required. |
--max-uses <number|unlimited> | Number of times the link can be redeemed, or unlimited; default 1. |
--restricted-domains <domains> | Comma-separated email domains allowed to redeem the link, for example example.com,example.org. |
Examples
excalidraw workspace invites create-link --role member
excalidraw workspace invites create-link --role admin --max-uses 1
excalidraw workspace invites create-link --role member --max-uses unlimited
excalidraw workspace invites create-link --role member --restricted-domains example.com,example.orgNotes
- Links are single-use unless you pass
--max-uses. Useunlimitedfor a link that never runs out. --restricted-domainslimits redemption to users whose email matches one of the domains.
invites update
Change an invite's email address, role, or maximum usage count.
excalidraw workspace invites update [options] <inviteId>| Argument | Description |
|---|---|
<inviteId> | Workspace invite ID to update. |
| Option | Description |
|---|---|
--email <email> | New invitee email for email invites. |
--role <role> | Workspace role to grant: member or admin. |
--max-uses <number|unlimited> | Maximum number of invite redemptions, or unlimited. |
--restricted-domains <domains> | Comma-separated email domains allowed to redeem the link, or none to remove the restriction. |
Examples
excalidraw workspace invites update <inviteId> --role admin
excalidraw workspace invites update <inviteId> --max-uses 5
excalidraw workspace invites update <inviteId> --restricted-domains example.com
excalidraw workspace invites update <inviteId> --restricted-domains noneNotes
- Provide at least one field to update. Omitted fields stay unchanged.
- Email invites cannot update max uses or restricted domains. Link invites cannot update email.
invites delete
Delete an invite so the email invitation or invite link can no longer be used.
excalidraw workspace invites delete [options] <inviteId>| Argument | Description |
|---|---|
<inviteId> | Workspace invite ID to revoke. |
Examples
excalidraw workspace invites delete <inviteId>Notes
- Revoking an invite prevents future redemption but does not remove users who already joined.
- Only pending invites can be revoked; redeemed invites return an error.
Last updated on
