Preview segment

Outcome

Count the active contacts matching a filter or a saved segmentId (exactly one) and return the first page of 50. With a contactability filter at most 2000 contacts are counted and countCapped says when more may match. Nothing is written.

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.preview --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.preview --data @payload.json --json
topolo actions plan app_topolo_engage.segments.preview --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.preview --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 > refuses writes to readers and over-complex filters, but lets readers list and preview

Action input

{
  "segmentId": "segment_1"
}

Actual local response

{
  "count": 0,
  "countCapped": false,
  "contacts": [],
  "nextCursor": null
}

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

Captured HTTP 200 · ICP filters over the published actions > segments.preview > counts and pages a filter or a saved segment

Action input

{
  "filter": {
    "companyIn": [
      "acme"
    ]
  }
}

Actual local response

{
  "count": 2,
  "countCapped": false,
  "contacts": [
    {
      "id": "contact_2",
      "email": "bob@acme.io",
      "domain": "acme.io",
      "addressType": "person",
      "verificationStatus": "unknown",
      "firstName": null,
      "lastName": null,
      "company": "Acme",
      "title": "Sales Manager",
      "website": null,
      "country": null,
      "timezone": null,
      "source": "manual",
      "custom": {},
      "createdAt": "2026-10-01T00:00:00.000Z",
      "updatedAt": "2026-10-01T00:00:00.000Z",
      "archivedAt": null
    },
    {
      "id": "contact_1",
      "email": "ada@acme.io",
      "domain": "acme.io",
      "addressType": "person",
      "verificationStatus": "unknown",
      "firstName": null,
      "lastName": null,
      "company": "Acme",
      "title": "CTO",
      "website": null,
      "country": null,
      "timezone": null,
      "source": "manual",
      "custom": {},
      "createdAt": "2026-10-01T00:00:00.000Z",
      "updatedAt": "2026-10-01T00:00:00.000Z",
      "archivedAt": null
    }
  ],
  "nextCursor": null
}

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

Captured HTTP 200 · ICP filters over the published actions > segments.preview > counts and pages a filter or a saved segment

Action input

{
  "segmentId": "segment_1"
}

Actual local response

{
  "count": 1,
  "countCapped": false,
  "contacts": [
    {
      "id": "contact_3",
      "email": "cy@globex.com",
      "domain": "globex.com",
      "addressType": "person",
      "verificationStatus": "unknown",
      "firstName": null,
      "lastName": null,
      "company": "Globex",
      "title": "VP Marketing",
      "website": null,
      "country": null,
      "timezone": null,
      "source": "manual",
      "custom": {},
      "createdAt": "2026-10-01T00:00:00.000Z",
      "updatedAt": "2026-10-01T00:00:00.000Z",
      "archivedAt": null
    }
  ],
  "nextCursor": null
}

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

Effects and response meaning

• Count the active contacts matching a filter or a saved segmentId (exactly one) and return the first page of 50. With a contactability filter at most 2000 contacts are counted and countCapped says when more may match. Nothing is written.

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.

Capture exceptions

The following successful route capture was retained in the source fixtures but omitted from worked examples because it does not satisfy the declared output schema. Do not treat it as a schema-valid response.

[
  {
    "testName": "ICP filters over the published actions > segments.preview > caps the contactability count and says so",
    "errors": [
      {
        "path": "$.contacts[0].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[0].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[1].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[1].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[2].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[2].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[3].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[3].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[4].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[4].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[5].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[5].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[6].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[6].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[7].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[7].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[8].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[8].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[9].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[9].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[10].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[10].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[11].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[11].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[12].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[12].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[13].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[13].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[14].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[14].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[15].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[15].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[16].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[16].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[17].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[17].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[18].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[18].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[19].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[19].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[20].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[20].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[21].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[21].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[22].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[22].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[23].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[23].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[24].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[24].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[25].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[25].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[26].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[26].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[27].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[27].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[28].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[28].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[29].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[29].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[30].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[30].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[31].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[31].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[32].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[32].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[33].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[33].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[34].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[34].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[35].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[35].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[36].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[36].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[37].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[37].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[38].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[38].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[39].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[39].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[40].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[40].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[41].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[41].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[42].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[42].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[43].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[43].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[44].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[44].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[45].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[45].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[46].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[46].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[47].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[47].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[48].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[48].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[49].createdAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      },
      {
        "path": "$.contacts[49].updatedAt",
        "code": "format_date_time",
        "message": "Expected an ISO-8601 date-time."
      }
    ]
  }
]

Refused requests

Captured HTTP 422 · ICP filters over the published actions > segments > refuses writes to readers and over-complex filters, but lets readers list and preview

Action input

{
  "filter": {
    "titleAny": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ],
    "companyIn": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ],
    "countryIn": [
      "v0",
      "v1",
      "v2",
      "v3",
      "v4",
      "v5",
      "v6",
      "v7",
      "v8",
      "v9",
      "v10",
      "v11",
      "v12",
      "v13",
      "v14",
      "v15",
      "v16",
      "v17",
      "v18",
      "v19",
      "v20",
      "v21",
      "v22",
      "v23",
      "v24"
    ]
  }
}

Actual local response

{
  "error": {
    "code": "filter_too_complex",
    "message": "A filter may bind at most 60 values; this one binds 75."
  }
}

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

Captured HTTP 404 · ICP filters over the published actions > segments.preview > counts and pages a filter or a saved segment

Action input

{
  "segmentId": "segment_9"
}

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.

Captured HTTP 422 · ICP filters over the published actions > segments.preview > counts and pages a filter or a saved segment

Refused input; do not execute

{}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for segments.preview is invalid.",
    "details": [
      {
        "code": "custom",
        "path": [],
        "message": "Provide exactly one of filter or segmentId."
      }
    ]
  }
}

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

Captured HTTP 422 · ICP filters over the published actions > segments.preview > counts and pages a filter or a saved segment

Refused input; do not execute

{
  "filter": {},
  "segmentId": "segment_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for segments.preview is invalid.",
    "details": [
      {
        "code": "custom",
        "path": [],
        "message": "Provide exactly one of filter or segmentId."
      }
    ]
  }
}

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

Error recovery

• HTTP 422 filter_too_complex: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
• 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.
• HTTP 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.

Related actions

• List segments
• Create segment
• Get segment
• Update segment
• Delete segment

Evidence and limits

• /api/segments/preview

• 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.