Get lead scoring model

Read the workspace's lead scoring model: the editable draft, the published version scores are computed against, whether the draft has unpublished changes, and the handoff targets (active lead_handoff connectors, plus targets Nurture cannot reach yet and why). Score = fit + behaviour. Fit rules add points when a contact field matches (equals, not_equals, contains, exists, not_exists). Behaviour rules add points per matching lifecycle event (optionally only when properties[key] equals a value), each event halving every halfLifeDays (0 = no decay), with the rule clipped to maxPoints. A contact qualifies when score >= mqlThreshold.

Outcome

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.

Discover the target

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

Request

GET /api/scoring/model

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 the model without changing state; before the first save the draft is empty with mqlThreshold 100.

Interpret the response

The model version is an integer or null, not a resource identifier. Inspect the model or recompute outcome and discover contacts separately before using contact ids.

Confirm $.model.published is the version you expect.

Exact success schema:

{
  "type": "object",
  "required": [
    "model",
    "handoff"
  ],
  "properties": {
    "model": {
      "type": "object",
      "required": [
        "draft",
        "currentVersion",
        "published",
        "hasUnpublishedChanges"
      ],
      "properties": {
        "draft": {
          "type": "object",
          "required": [
            "behaviourRules",
            "fitRules",
            "mqlThreshold"
          ],
          "properties": {
            "behaviourRules": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "fitRules": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "mqlThreshold": {
              "type": "integer"
            }
          }
        },
        "currentVersion": {
          "type": [
            "integer",
            "null"
          ]
        },
        "hasUnpublishedChanges": {
          "type": "boolean"
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "updatedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "published": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "version": {
              "type": "integer"
            },
            "model": {
              "type": "object",
              "required": [
                "behaviourRules",
                "fitRules",
                "mqlThreshold"
              ],
              "properties": {
                "behaviourRules": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "fitRules": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "mqlThreshold": {
                  "type": "integer"
                }
              }
            },
            "publishedAt": {
              "type": "string"
            },
            "publishedBy": {
              "type": "string"
            }
          }
        }
      }
    },
    "handoff": {
      "type": "object",
      "required": [
        "connectors",
        "unavailable"
      ],
      "properties": {
        "connectors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "connectorId": {
                "type": "string"
              },
              "provider": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "config": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              }
            }
          }
        },
        "unavailable": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "provider": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

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.scoring_model.get --data @payload.json --json
topolo actions plan app_topolo_nurture.scoring_model.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.scoring_model.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.scoring_model.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "model": {
    "draft": {
      "behaviourRules": [],
      "fitRules": [],
      "mqlThreshold": 100
    },
    "currentVersion": null,
    "published": null,
    "hasUnpublishedChanges": true,
    "updatedAt": null,
    "updatedBy": null
  },
  "handoff": {
    "connectors": [
      {
        "connectorId": "con_5766e7ce2d2347938c200cf42fddc8a7",
        "provider": "topolo_crm",
        "status": "active",
        "config": {
          "crmWorkspaceId": "crm_ws"
        }
      }
    ],
    "unavailable": []
  }
}

HTTP 200. Confirm $.model.published is the version you expect.

Another supported request

Input · payload.json:

{}

CLI:

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

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.scoring_model.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "model": {
    "draft": {
      "behaviourRules": [],
      "fitRules": [
        {
          "id": "saas",
          "field": "industry",
          "operator": "equals",
          "value": "saas",
          "points": 20
        }
      ],
      "mqlThreshold": 20
    },
    "currentVersion": 1,
    "published": {
      "version": 1,
      "model": {
        "behaviourRules": [],
        "fitRules": [
          {
            "id": "saas",
            "field": "industry",
            "operator": "equals",
            "value": "saas",
            "points": 20
          }
        ],
        "mqlThreshold": 20
      },
      "publishedAt": "2026-10-04T00:32:36.122Z",
      "publishedBy": "u1"
    },
    "hasUnpublishedChanges": false,
    "updatedAt": "2026-10-04T00:32:36.122Z",
    "updatedBy": "u1"
  },
  "handoff": {
    "connectors": [
      {
        "connectorId": "con_82612d77e25042ab8986d3bc16eaef05",
        "provider": "topolo_engage",
        "status": "active",
        "config": {
          "engageWorkspaceId": "eng_ws",
          "campaignId": "cmp_open",
          "seatId": "seat_1"
        }
      }
    ],
    "unavailable": []
  }
}

HTTP 200. Confirm $.model.published is the version you expect.

Refused request · permission_denied

Input · payload.json:

{}

CLI:

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

Captured local response · HTTP 403:

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:read.",
    "details": {
      "requiredPermission": "workspace:read"
    }
  }
}

HTTP 403. Preserve the refusal details and do not claim success.

Verify the result

Confirm $.model.published is the version you expect.

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

This action does not change service state.

Update lead scoring draft: Replace the draft lead scoring model (behaviourRules, fitRules, mqlThreshold; up to 50 rules each with unique ids). Scores do not change until scoring_model.publish. Score = fit + behaviour. Fit rules add points when a contact field matches (equals, not_equals, contains, exists, not_exists). Behaviour rules add points per matching lifecycle event (optionally only when properties[key] equals a value), each event halving every halfLifeDays (0 = no decay), with the rule clipped to maxPoints. A contact qualifies when score >= mqlThreshold.
Publish lead scoring model: Freeze the draft as the next model version, make it current and rescore every active contact (up to 5000; truncated says when more remain, finish with scoring.recompute). The first time a contact qualifies Nurture records one mql lifecycle event (journey trigger and goal, segment event condition) and queues a handoff to every active connector with lead_handoff (TopoloCRM: a follow-up task on the linked CRM contact; TopoloEngage: enrolment into the connector's Engage campaign from its seat, skipped for an archived Engage contact or an address with a hard bounce, complaint or wrong-person block); without one the contact stays in Nurture (scoring.qualified.list, segment condition lead_score).

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.

Get lead scoring model

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · permission_denied

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence