Team

Team.findMember searches the organization that owns the agent for members whose name, email address, or user id matches, and returns the WhatsApp, SMS, and email handles each of them chose to share. Pair it with Channels.send to message a colleague without hard-coding a number. Available in tools, jobs, webhooks, triggers, processors, and workflow code steps. Verified against lua-cli 3.33.0.

import { Team } from 'lua-cli';

Quick example

A search returns a list; disambiguate when more than one member matches.

import { Team } from 'lua-cli';

const { matches } = await Team.findMember('Stefan');
const whatsapp = matches[0]?.targets.find((t) => t.channel === 'whatsapp');

Methods

findMember(name)

Returns the organization members matching a name, email address, or user id, with their shared handles.

Team.findMember(name: string): Promise<DirectoryResolveResult>

string

required

The text to match: a case-insensitive substring of a member’s full name or of any of their email addresses, or an exact user id. Whitespace only returns no matches.

A member is a person with an active membership in the agent’s organization, as managed in the admin dashboard; deactivated members are never returned. A handle appears in targets only when the member marked it shareable in their profile, so targets can be empty. The organization is derived from the agent; you can’t resolve members of another organization. Returns

DirectoryResolveResult

Show properties

string

The trimmed text that was matched.

DirectoryMatch[]

One entry per matching member: userId, fullName?, primaryEmail?, and targets, an array of DirectoryTarget.

interface

Show properties

'whatsapp' | 'sms' | 'email'

The channel the handle is for.

string

An E.164 number for whatsapp and sms; an address for email.

string

The member’s own label for the handle, such as work.

boolean

Whether the member verified the handle.

Example

import { LuaTool, Team, Channels } from 'lua-cli';
import { z } from 'zod';

export default class NotifyColleagueTool implements LuaTool {
  name = 'notify_colleague';
  description = 'Send a WhatsApp message to a named teammate';
  inputSchema = z.object({
    name: z.string().describe('Teammate name or email'),
    message: z.string(),
  });

  async execute(input: z.infer<typeof this.inputSchema>) {
    const { matches } = await Team.findMember(input.name);
    if (matches.length !== 1) {
      return { sent: false, candidates: matches.map((m) => m.fullName ?? m.userId) };
    }
    const target = matches[0].targets.find((t) => t.channel === 'whatsapp');
    if (!target) return { sent: false, reason: 'no shared WhatsApp number' };

    const result = await Channels.send({
      channel: 'whatsapp',
      to: { phoneNumber: target.value },
      text: input.message,
    });
    return { sent: true, deliveryId: result.deliveryId };
  }
}

Errors — the call throws. In a deployed agent the error is a DirectoryResolveError with code and statusCode; in lua test it is a plain Error carrying the server’s message, or Directory resolve failed.

name is required when name is empty.
Agent is not linked to an organization.
A 403 when the agent isn’t yours.

Types

DirectoryResolveResult, DirectoryMatch, and DirectoryTarget are exported from lua-cli with the shapes listed under findMember(name).

SDK

CLI

REST API

Quick example

Methods

findMember(name)

Types

See also

​Quick example

​Methods

​findMember(name)

​Types

​See also

Quick example

Methods

findMember(name)

Types

See also