Developer

Places API

List places in the workspace via ctx.sdk.places.

ctx.sdk.places lists the places in the workspace. It is a read-only discovery surface.

Scope required: places:read

Usage

import { defineMethod } from "@rightplace/applet-sdk/v2";

export default defineMethod("loadPlaces", async (ctx) => {
  const places = await ctx.sdk.places.list();
  return places;
});

Manifest

Declare the scope in applet.json:

{
  "scopes": ["places:read"]
}

Notes

  • ctx.sdk.places.list() returns the places in the workspace.
  • This surface is read-only. It cannot create, update, or delete places.