Skip to main content
reachboost users has 4 commands. Each one lists its arguments, its flags and what it is allowed to change. Every command also accepts the global flags.

users get

Get a workspace member. Read-only.
Usage
Arguments
uuid
required
The unique identifier for the workspace member.

users list

List workspace members. Read-only. The people who have access to the workspace, newest first. Filters combine with AND across fields. first_name, last_name and email match partial, case-insensitive text. role matches exactly; give several values separated by commas to match any of them. Unknown filter values apply no restriction.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Partial match filter on the first name (case-insensitive).
string
Partial match filter on the last name (case-insensitive).
string
Partial match filter on the email address (case-insensitive).
string
Exact match on the role, one or more of workspace_member, workspace_admin, agency_member, agency_admin separated by commas.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.

users delete

Remove a workspace member. Irreversible: needs —yes and —confirm-name. Removes the member and the invitations they sent, in this workspace and in any other workspace they invited into, and drops them from the access list of every workspace they were given access to. Admins cannot be removed through the API, and neither can the last admin of the workspace; both answer 422 with a message.
Cannot be undone. Needs --yes and --confirm-name. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the workspace member.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.
string
The exact member email, repeated as a check that this is the right target. Cannot be undone.

users update

Update a workspace member. Changes data. Changes the member’s first or last name. Nothing else is writable here: an email address, a role, a uuid or a timestamp in the body is refused with 422. The email address stays out of reach on purpose, since whoever could change it could request a password reset to the new address and take the account over.
Usage
Arguments
uuid
required
The unique identifier for the workspace member.
Flags
string
string
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.