Docs: Tool reference
customers toolset

search_users

Search customers. Finds end users (customers) by email, name or external ID, optionally within a company, with their companies and counts of posts, votes and comments. Use it to look someone up before logging feedback or editing them. Team only. No side effects.

Toolset
customers
Who can call it
OwnersManagersContributorsAPI keys
REST
GET /api/v1/w/{workspace}/users
Behavior
read-onlyidempotent

Input

FieldTypeDescription
querystringPart of an email, name or external ID.
companystringThe company's ID (co_…), external ID or exact name.
sortone of: newest, name, last_active Default: "newest".
limitintegerItems per page (default 25, max 100). Default: 25.
cursorstringPass the previous response's next_cursor to get the next page.

Output

FieldTypeDescription
itemsrequiredarray of object
next_cursorrequiredstring or nullCursor for the next page, or null when this is the last page.

Calling it

// MCP: tools/call
{ "name": "search_users", "arguments": {} }

// Typed client
await carechannel.search_users({});