Skip to main content
The Groups service provides methods for managing user groups.

Overview

import { SnackBaseClient } from "@snackbase/sdk";

const client = new SnackBaseClient({
  baseUrl: "https://api.example.com",
});

// Access the groups service
const groups = client.groups;

List Groups

const result = await client.groups.list();

Get a Group

const group = await client.groups.get("group-id");

Create a Group

const group = await client.groups.create({
  name: "Editors",
  description: "Content editors team",
});

Update a Group

const updated = await client.groups.update("group-id", {
  name: "Senior Editors",
});

Delete a Group

await client.groups.delete("group-id");
Deleting a group removes it from all users. The users themselves are not deleted.

Add User to Group

await client.groups.addUser("group-id", "user-id");

Remove User from Group

await client.groups.removeUser("group-id", "user-id");

Get Group Members

const members = await client.groups.getMembers("group-id");

Next Steps