Skip to main content

Members

cstar.members manages seats and roles. There's a sub-resource for invites — pending seats that haven't been claimed yet. Six roles total: Owner, Admin, Manager, Librarian, Agent, Spectator.

List members

list.js
const { data: members } = await cstar.members.list({
  role: 'agent',     // Filter by role
  page: 1,
  pageSize: 50
});

Get a single member

get.js
const member = await cstar.members.get('mem_abc123');
console.log(member.email, member.role, member.gameTitle);

Change a role

update.js
await cstar.members.update('mem_abc123', { role: 'manager' });

Roles: owner, admin, manager, librarian, agent, spectator. Only an owner can promote someone to owner.

Remove a member

del.js
// 'del' is the canonical name on this resource (not 'delete')
await cstar.members.del('mem_abc123');

Invites sub-resource

Pending seats that haven't been claimed. Create an invite, list outstanding ones, revoke if you change your mind.

invites.js
// Send an invite
const invite = await cstar.members.invites.create({
  email: 'newhire@your-team.com',
  role: 'agent'
});

// List outstanding
const { data: pending } = await cstar.members.invites.list();

// Revoke
await cstar.members.invites.del(invite.id);

Next up