Skip to content

WorkspacesService

Use client.workspaces for workspaces, membership, feature flags, custom-field schemas, and wallet certificates.

Workspace methods

MethodPurpose
list() / getMy()List accessible workspaces
get(id)Read a workspace
create(data)Create a workspace; system-admin permission required
update(id, data)Update a workspace
delete(id) / deleteWorkspace(id)Delete a workspace
clearWorkspace(id)Clear workspace-owned data
search(query) / getByName(name)Find workspaces
getWithRelations(id)Load workspace relations
getStats(id)Get workspace counts
isNameAvailable(name)Check a name
typescript
const { data: workspaces } = await client.workspaces.list();
const workspace = workspaces[0];
const stats = await client.workspaces.getStats(workspace.id);

Members and feature flags

typescript
const members = await client.workspaces.getMembers("workspace-uuid");
await client.workspaces.addMember("workspace-uuid", "user-uuid", {
  role: "member",
});
await client.workspaces.removeMember("workspace-uuid", "user-uuid");

const flags = await client.workspaces.getFeatureFlags("workspace-uuid");

Client data model

typescript
const model = await client.workspaces.getDataModel("workspace-uuid");

await client.workspaces.createDataModelField("workspace-uuid", {
  field_name: "preferred_store",
  field_label: "Preferred store",
  field_type: "string",
});

const validation = await client.workspaces.validateCustomFields(
  "workspace-uuid",
  { preferred_store: "Downtown" },
);

The data-model methods also support updating, deleting, reordering fields, and resolving defaults.

Certificates

Certificate methods cover listing, CSR creation/download, certificate upload, validation, and deletion. Every method requires the workspace ID and certificate ID where applicable.

WalletHero Documentation