Topolo Docs Topolo Platform
Open workspace

Export contact data

Subject-access export of everything Engage holds about one contact in the current workspace: profile and custom fields, email points, phone and WhatsApp consent evidence, list memberships, suppression ledger events and send reservations, enrollments, messages (subject and text as sent), tasks, reply threads with inbound and outbound message bodies, AI qualifications, and first-touch analytics facts. Each kind is capped at 2000 rows, newest first, with truncated naming any kind that was cut. Read-only; the export itself is audited. 404 when the contact is not in this workspace.

Outcome

Subject-access export of everything Engage holds about one contact in the current workspace: profile and custom fields, email points, phone and WhatsApp consent evidence, list memberships, suppression ledger events and send reservations, enrollments, messages (subject and text as sent), tasks, reply threads with inbound and outbound message bodies, AI qualifications, and first-touch analytics facts. Each kind is capped at 2000 rows, newest first, with truncated naming any kind that was cut. Read-only; the export itself is audited. 404 when the contact is not in this workspace.

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.contacts.export --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
idYes{"type":"string","minLength":1,"maxLength":128}

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.contacts.export --data @payload.json --json
topolo actions plan app_topolo_engage.contacts.export --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.contacts.export --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 · contacts.export > returns everything held about a replied contact, for a reader, and audits the export

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "exportedAt": "2026-10-06T08:30:00.000Z",
  "contact": {
    "id": "contact_1",
    "email": "ada@acme.io",
    "domain": "acme.io",
    "addressType": "person",
    "verificationStatus": "unknown",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "company": "Analytical",
    "title": null,
    "website": null,
    "country": null,
    "timezone": null,
    "source": "manual",
    "custom": {},
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "archivedAt": null
  },
  "truncated": [],
  "contactPoints": [
    {
      "id": "contactPoint_1",
      "address": "ada@acme.io",
      "domain": "acme.io",
      "address_type": "person",
      "verification_status": "unknown",
      "is_primary": 1,
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "phones": [],
  "consentEvents": [],
  "listMemberships": [],
  "ledgerEvents": [
    {
      "id": "eng_le_w1",
      "channel": "email",
      "event_type": "reply_stop",
      "topic_key": null,
      "source_app": "topolo-nexus",
      "reason": "provider:email_inbound_1",
      "occurred_at": "2026-10-06T08:30:00.000Z",
      "recorded_at": "2026-10-06T08:30:00.000Z",
      "recorded_by": "topolo-nexus"
    }
  ],
  "sendReservations": [
    {
      "id": "eng_rsv_1",
      "channel": "email",
      "purpose": "outreach",
      "source_app": "topolo-engage",
      "status": "consumed",
      "planned_at": "2026-10-06T08:30:00.000Z",
      "expires_at": "2026-10-06T08:45:00.000Z",
      "created_at": "2026-10-06T08:30:00.000Z",
      "consumed_at": "2026-10-06T08:30:00.000Z",
      "release_reason": null
    }
  ],
  "enrollments": [
    {
      "id": "eng_enr_1",
      "campaign_id": "eng_cmp_1",
      "sequence_version_id": "eng_seqv_1",
      "seat_id": "eng_seat_1",
      "status": "replied",
      "stop_reason": "reply",
      "outcome": null,
      "outcome_at": null,
      "enrolled_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "messages": [
    {
      "id": "eng_msg_2",
      "enrollment_id": "eng_enr_1",
      "campaign_id": "eng_cmp_1",
      "step_position": 2,
      "subject": null,
      "text_body": null,
      "status": "cancelled",
      "hold_reason": "reply",
      "scheduled_for": "2026-10-10T08:30:00.000Z",
      "sent_at": null,
      "outcome": null,
      "outcome_at": null,
      "created_at": "2026-10-06T08:30:00.000Z"
    },
    {
      "id": "eng_msg_1",
      "enrollment_id": "eng_enr_1",
      "campaign_id": "eng_cmp_1",
      "step_position": 1,
      "subject": "Quick question, Ada",
      "text_body": "Hi Ada,\n\nHow is Analytical handling outreach?\n\nAsh\n\n--\nTest opt-out sentence for fixtures.\nExample Ltd\n1 Example Street\nLondon",
      "status": "sent",
      "hold_reason": null,
      "scheduled_for": "2026-10-06T08:30:00.000Z",
      "sent_at": "2026-10-06T08:30:00.000Z",
      "outcome": "replied",
      "outcome_at": "2026-10-06T08:30:00.000Z",
      "created_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "tasks": [],
  "threads": [
    {
      "id": "eng_thr_1",
      "enrollment_id": "eng_enr_1",
      "campaign_id": "eng_cmp_1",
      "subject": "Quick question, Ada",
      "status": "open",
      "intent": "unclassified",
      "first_reply_at": "2026-10-06T08:30:00.000Z",
      "last_reply_at": "2026-10-06T08:30:00.000Z",
      "closed_at": null,
      "follow_up_on": null,
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "threadMessages": [
    {
      "id": "eng_thm_1",
      "thread_id": "eng_thr_1",
      "direction": "inbound",
      "snippet": "Sounds interesting",
      "body_text": "Sounds interesting, tell me more.",
      "auto_reply": 0,
      "received_at": "2026-10-06T08:30:00.000Z",
      "sent_at": null,
      "created_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "qualifications": [],
  "analyticsFacts": [
    {
      "enrollment_id": "eng_enr_1",
      "campaign_id": "eng_cmp_1",
      "sequence_id": "eng_seq_1",
      "step_position": 1,
      "subject_label": "Quick question, {{first_name}}",
      "first_sent_at": "2026-10-06T08:30:00.000Z",
      "replied": 1,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ]
}

Source test: contacts.export > returns everything held about a replied contact, for a reader, and audits the export. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contacts.export > exports a contact that was never enrolled with empty dependent kinds

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "exportedAt": "2026-10-06T08:30:00.000Z",
  "contact": {
    "id": "contact_1",
    "email": "grace@navy.mil",
    "domain": "navy.mil",
    "addressType": "person",
    "verificationStatus": "unknown",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "company": "Analytical",
    "title": null,
    "website": null,
    "country": null,
    "timezone": null,
    "source": "manual",
    "custom": {},
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "archivedAt": null
  },
  "truncated": [],
  "contactPoints": [
    {
      "id": "contactPoint_1",
      "address": "grace@navy.mil",
      "domain": "navy.mil",
      "address_type": "person",
      "verification_status": "unknown",
      "is_primary": 1,
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "phones": [],
  "consentEvents": [],
  "listMemberships": [],
  "ledgerEvents": [],
  "sendReservations": [],
  "enrollments": [],
  "messages": [],
  "tasks": [],
  "threads": [],
  "threadMessages": [],
  "qualifications": [],
  "analyticsFacts": []
}

Source test: contacts.export > exports a contact that was never enrolled with empty dependent kinds. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contacts.export > includes the contact AI qualification

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "exportedAt": "2026-10-06T08:30:00.000Z",
  "contact": {
    "id": "contact_1",
    "email": "grace@navy.mil",
    "domain": "navy.mil",
    "addressType": "person",
    "verificationStatus": "unknown",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "company": "Analytical",
    "title": null,
    "website": null,
    "country": null,
    "timezone": null,
    "source": "manual",
    "custom": {},
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "archivedAt": null
  },
  "truncated": [],
  "contactPoints": [
    {
      "id": "contactPoint_1",
      "address": "grace@navy.mil",
      "domain": "navy.mil",
      "address_type": "person",
      "verification_status": "unknown",
      "is_primary": 1,
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "phones": [],
  "consentEvents": [],
  "listMemberships": [],
  "ledgerEvents": [],
  "sendReservations": [],
  "enrollments": [],
  "messages": [],
  "tasks": [],
  "threads": [],
  "threadMessages": [],
  "qualifications": [
    {
      "score": 80,
      "fit": "strong",
      "reasons_json": "[\"Title matches\"]",
      "missing_json": "[]",
      "brief_hash": "h",
      "model": "m",
      "qualified_at": "now",
      "qualified_by": "user_1"
    }
  ],
  "analyticsFacts": []
}

Source test: contacts.export > includes the contact AI qualification. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · contact phone and WhatsApp opt-in > erasure deletes the phone and consent evidence; the export includes them

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "exportedAt": "2026-10-06T08:30:00.000Z",
  "contact": {
    "id": "contact_1",
    "email": "ada@acme.io",
    "domain": "acme.io",
    "addressType": "person",
    "verificationStatus": "unknown",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "company": "Analytical",
    "title": null,
    "website": null,
    "country": null,
    "timezone": null,
    "source": "manual",
    "custom": {},
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "archivedAt": null
  },
  "truncated": [],
  "contactPoints": [
    {
      "id": "contactPoint_1",
      "address": "ada@acme.io",
      "domain": "acme.io",
      "address_type": "person",
      "verification_status": "unknown",
      "is_primary": 1,
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "phones": [
    {
      "phone_e164": "+447700900123",
      "created_at": "2026-10-06T08:30:00.000Z",
      "updated_at": "2026-10-06T08:30:00.000Z"
    }
  ],
  "consentEvents": [
    {
      "id": "consentEvent_1",
      "channel": "whatsapp",
      "event_type": "opt_in",
      "source": "Webinar form",
      "evidence": "Ticked the box",
      "recorded_at": "2026-10-06T08:30:00.000Z",
      "recorded_by": "user_1"
    }
  ],
  "listMemberships": [],
  "ledgerEvents": [],
  "sendReservations": [],
  "enrollments": [],
  "messages": [],
  "tasks": [],
  "threads": [],
  "threadMessages": [],
  "qualifications": [],
  "analyticsFacts": []
}

Source test: contact phone and WhatsApp opt-in > erasure deletes the phone and consent evidence; the export includes them. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Subject-access export of everything Engage holds about one contact in the current workspace: profile and custom fields, email points, phone and WhatsApp consent evidence, list memberships, suppression ledger events and send reservations, enrollments, messages (subject and text as sent), tasks, reply threads with inbound and outbound message bodies, AI qualifications, and first-touch analytics facts. Each kind is capped at 2000 rows, newest first, with truncated naming any kind that was cut. Read-only; the export itself is audited. 404 when the contact is not in this workspace.

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 · contacts.export > answers 404 for a contact outside the workspace

Action input

{
  "id": "contact_1"
}

Actual local response

{
  "error": {
    "code": "not_found",
    "message": "Contact was not found."
  }
}

Source test: contacts.export > answers 404 for a contact outside the workspace. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · contacts.export > answers 404 for a contact outside the workspace

Action input

{
  "id": "eng_ct_missing"
}

Actual local response

{
  "error": {
    "code": "not_found",
    "message": "Contact was not found."
  }
}

Source test: contacts.export > answers 404 for a contact outside the workspace. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

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

Evidence and limits

  • /api/contacts/{id}/export

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