Topolo Docs Topolo Platform
Open workspace

Get workspace settings

Read this Nurture workspace's settings. The CRM link formerly stored here (crmWorkspaceId) is now a TopoloCRM connector: a workspace that still had one gets an equivalent connector (capability contact_source) on this call and the setting is cleared.

Outcome

Read this Nurture workspace's settings. The CRM link formerly stored here (crmWorkspaceId) is now a TopoloCRM connector: a workspace that still had one gets an equivalent connector (capability contact_source) on this call and the setting is cleared.

Before you start

  • Verify identity and pin the intended organization and environment before discovering the action.
  • Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
  • Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
  • Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.settings.get --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

GET /api/settings

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Use an empty JSON object; verified credential and resource context are separate.

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Effects

  • Reads workspace settings. Migrates a legacy crmWorkspaceId link into a TopoloCRM connector once, if one is still stored.

Interpret the response

This is a workspace configuration or policy response, not an independently identified resource. Inspect its values and verify changes with the corresponding read action.

Confirm $.settings is present.

Exact success schema:

{
  "type": "object",
  "required": [
    "settings"
  ],
  "properties": {
    "settings": {
      "type": "object",
      "required": [
        "updatedAt"
      ],
      "properties": {
        "updatedAt": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_nurture.settings.get --data @payload.json --json
topolo actions plan app_topolo_nurture.settings.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.settings.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.settings.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "settings": {
    "updatedAt": "2026-10-04T00:32:36.283Z"
  }
}

HTTP 200. Confirm $.settings is present.

Another supported request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_nurture.settings.get --data @payload.json --json
topolo actions plan app_topolo_nurture.settings.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.settings.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.settings.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "settings": {
    "updatedAt": null
  }
}

HTTP 200. Confirm $.settings is present.

Verify the result

  • Confirm $.settings is present.

Errors and recovery

  • organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
  • permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
  • workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
  • invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

The one-way legacy CRM link migration clears the retired setting and retains an existing connector or creates its equivalent. Inspect connectors.list with confirmation; manage connector configuration through its documented actions rather than restoring the retired setting.

  • List connectors: List the connectors in the caller's Nurture workspace (any status) with their enabled capabilities, config, last sync time, resume cursor and last error. A workspace that still has the retired settings.crmWorkspaceId link gets an equivalent TopoloCRM connector (contact_source) on this call.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.