UsersResource

API reference for the Users resource.

Methods

list

List all users.

async list(): Promise<ListResponse<User>>

get

Get a single user by ID.

async get(id: string): Promise<User>

create

Create a new user.

async create(data: CreateUserInput): Promise<User>

Parameters:

interface CreateUserInput {
  email: string;
  name: string;
  role?: string;
}

update

Update an existing user.

async update(id: string, data: UpdateUserInput): Promise<User>

Parameters:

interface UpdateUserInput {
  name?: string;
  role?: string;
  status?: 'active' | 'inactive';
}

delete

Delete a user.

async delete(id: string): Promise<void>

Types

User

interface User {
  id: string;
  type: 'user';
  email: string;
  name: string;
  role?: string;
  status: 'active' | 'inactive' | 'pending';
  createdAt: Date;
  updatedAt: Date;
}

Example

// List all users
const response = await client.users.list();

for (const user of response.data) {
  console.log(`${user.name} (${user.email})`);
  console.log(`  Role: ${user.role}`);
  console.log(`  Status: ${user.status}`);
}