List segments

List the segments in the caller's Nurture workspace, optionally filtered by status. A segment is a rule set over contact fields (Nurture contacts, or the linked CRM workspace), Nurture lifecycle events and the lead score (kind lead_score: operator qualified, or at_least with a value).

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.segments.list --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

GET /api/segments

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

Field	Required	Type	Constraints
`status`	Optional	string	{"enum":["active","archived"]}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ]
    }
  },
  "additionalProperties": false
}

Effects

Reads segments without changing state.

Interpret the response

The returned identifier path is $.segments[].id for segment. Empty lists do not discover a target.

Confirm each returned segment belongs to the selected workspace.

Exact success schema:

{
  "type": "object",
  "required": [
    "segments"
  ],
  "properties": {
    "segments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "rules": {
            "type": "object"
          },
          "status": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "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:

{
  "status": "archived"
}

CLI:

topolo actions validate app_topolo_nurture.segments.list --data @payload.json --json
topolo actions plan app_topolo_nurture.segments.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.segments.list --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.segments.list",
    "input": {
      "status": "archived"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "segments": [
    {
      "id": "seg_f6186f56e1d7468d843b526226aee7b5",
      "name": "T",
      "description": "New trials",
      "rules": {
        "match": "any",
        "conditions": [
          {
            "kind": "event",
            "eventType": "signup",
            "operator": "performed",
            "withinDays": 7
          }
        ]
      },
      "status": "archived",
      "createdAt": "2026-10-04T00:32:38.719Z",
      "updatedAt": "2026-10-04T00:32:38.724Z"
    }
  ]
}

HTTP 200. Confirm each returned segment belongs to the selected workspace.

Refused request · invalid_input

Input · payload.json:

{
  "unsupported": "value"
}

CLI:

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

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "code": "unrecognized_keys",
        "keys": [
          "unsupported"
        ],
        "path": [],
        "message": "Unrecognized key: \"unsupported\""
      }
    ]
  }
}

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

Verify the result

Confirm each returned segment belongs to the selected workspace.

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.

Get segment: Read one segment by id from the caller's Nurture workspace.
Create segment: Create a segment in the caller's Nurture workspace. Rules match all or any of up to 20 conditions on contact fields or event recency.

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.