CLI Reference
Workspace Commands
CLI commands for managing workspaces, members, and roles
Workspace Commands
The workspace command group manages workspaces within an organization. Workspaces are subdivisions where data (contacts, disbursements, etc.) is scoped.
workspace list
List all workspaces in the current organization.
nextpay --env dev workspace listworkspace get
Get details of a specific workspace.
nextpay --env dev workspace get ws_abc123
# Get the current active workspace
nextpay --env dev workspace getworkspace use
Set the default workspace for subsequent commands.
nextpay --env dev workspace use ws_abc123workspace members list
List all members of the workspace.
nextpay --env dev workspace members listworkspace members add
Add a new member to the workspace by email.
nextpay --env dev workspace members add --email juan@example.com --role member| Flag | Required | Description |
|---|---|---|
--email | Yes | Email address of the user to add. |
--role | Yes | Role to assign. Valid values: admin, member, viewer, disbursement_manager, disbursement_authorizer, directory_manager. |
workspace members remove
Remove a member from the workspace.
nextpay --env dev workspace members remove --user-id user_abc123| Flag | Required | Description |
|---|---|---|
--user-id | Yes | User ID of the member to remove. |
workspace roles list
List all roles assigned in the workspace.
nextpay --env dev workspace roles listworkspace roles assign
Assign a role to a user in the workspace.
nextpay --env dev workspace roles assign --user-id user_abc123 --role disbursement_manager| Flag | Required | Description |
|---|---|---|
--user-id | Yes | User ID to assign the role to. |
--role | Yes | Role to assign. Valid values: admin, member, viewer, disbursement_manager, disbursement_authorizer, directory_manager. |
workspace roles remove
Remove a role from a user in the workspace.
nextpay --env dev workspace roles remove --user-id user_abc123 --role disbursement_manager| Flag | Required | Description |
|---|---|---|
--user-id | Yes | User ID to remove the role from. |
--role | Yes | Role to remove. |