Skip to main content
You do not need these names to use the server. Ask in plain language and the assistant picks the right tool. The list is here for when you want to know exactly what a connection can do. Most tools match a REST API endpoint and link to its reference. The server exposes five tools across three resources. Every tool takes an optional workspace argument, the subdomain of a connected workspace. Left out, it runs against the workspace the connection was set up with. ListWorkspaces reports the values you can pass. What a tool returns depends on the credential. Over OAuth, lists come back filtered to the permissions of the person who approved the connection, and a record they cannot open is refused rather than returned; an API key reaches the whole workspace. A tool that creates, updates, or deletes is also refused when the connection was not granted the Create and update or Delete permission. CreateUser needs Create and update, and DeactivateUser needs Delete.

Workspaces

ListWorkspaces has no REST endpoint, which is why it is not linked.

ListWorkspaces

Returns workspaces, each with name, subdomain and default (whether it is the workspace tools run against when none is named), alongside total_count, page, total_pages and page_size. Ordered by name.

Users

ListUsers

Returns users, each with email, role, first_name and last_name, alongside total_count, page, total_pages and page_size. Deactivated members are never returned.

CreateUser

Returns the invited user together with the apps grants the server resolved. Run ListProducts first so the name and role values match what the workspace offers.

DeactivateUser

Returns deactivated and the email. It fails if the user does not exist, is already deactivated, or if deactivating would leave the workspace without an owner. The action is recorded in the workspace audit log, and is reversible only through the NeetoAuth admin UI.

Products

ListProducts

Returns products, each with a name and its roles, alongside total_count, page, total_pages and page_size. Use the pairs to build the apps argument for CreateUser.