Get segment

Outcome

Get one saved segment and its ICP filter. Preview its matches with segments.preview segmentId=<id>.

Before you start

• Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:read.
• Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.segments.get --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.segments.get --data @payload.json --json
topolo actions plan app_topolo_engage.segments.get --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

Execute the unchanged validated read.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.segments.get --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · ICP filters over the published actions > segments > creates, lists, gets, updates and deletes a segment with audited writes

Action input

{
  "id": "segment_1"
}

Actual local response

{
  "segment": {
    "id": "segment_1",
    "name": "Tech leaders",
    "description": "CTOs",
    "filter": {
      "seniority": [
        "c_level"
      ]
    },
    "createdAt": "2026-10-01T00:00:00.000Z",
    "updatedAt": "2026-10-01T00:00:00.000Z"
  }
}

Source test: segments-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

• Get one saved segment and its ICP filter. Preview its matches with segments.preview segmentId=<id>.

Verify the outcome

• Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 404 · ICP filters over the published actions > segments > creates, lists, gets, updates and deletes a segment with audited writes

Action input

{
  "id": "segment_1"
}

Actual local response

{
  "error": {
    "code": "segment_not_found",
    "message": "Segment was not found in this workspace."
  }
}

Source test: segments-routes.test.ts. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

• HTTP 404 segment_not_found: Rediscover the identifier using the related list or get action in the same authorized resource. Do not guess identifiers or change organization context.

Related actions

• List segments
• Create segment
• Update segment
• Delete segment
• Preview segment

Evidence and limits

• /api/segments/{id}

• segments-routes.test.ts

• Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

• Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

• No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.