Skip to main content
Koru
Get started
API reference sections

Schema

Replacement

Type object or object or object or object

Shape

One of 4 shapes:

  1. state: "created"

    A Workspace manufactured for the emptied Profile. Never produced since Plan 1.2 of the root catalog. Kept on the wire so the generated schemas, an older client's decoder and every consumer that handled it are unchanged; new code branches on the other three.

    FieldTypeDescription
    staterequired"created"
    workspacerequiredWorkspace

    The unit of export, backup and - later - sharing.

    The same logical workspace may exist as several physical replicas: one per release channel, one per machine, one in the cloud. They share [id] and never share a database file.

    [id]: Workspace::id

  2. state: "existing"

    Another verified live Workspace of the source Profile.

    FieldTypeDescription
    staterequired"existing"
    workspacerequiredWorkspace

    The unit of export, backup and - later - sharing.

    The same logical workspace may exist as several physical replicas: one per release channel, one per machine, one in the cloud. They share [id] and never share a database file.

    [id]: Workspace::id

  3. state: "not_needed"

    The source Profile has no other live Workspace and stays empty, or a whole-Profile removal is in progress and wants none.

    FieldTypeDescription
    staterequired"not_needed"
  4. state: "unknown"

    The catalog publication did not commit, so nothing is known.

    FieldTypeDescription
    staterequired"unknown"
Example
{
  "state": "created",
  "workspace": {
    "id": "00000000-0000-4000-8000-000000000000",
    "owner": {},
    "name": "string",
    "created_at": 0,
    "last_opened_at": 0,
    "icon": "string",
    "color": "string",
    "pinned": false,
    "archived": false,
    "deleted_at": 0,
    "position": 0
  }
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.