Export Workspace Data
Queue a JSON file of every table of this workspace (secrets, password and key hashes, raw import files and embedding vectors left out). The owner only, signed in (API keys get 403).
API key access
/api/v1/workspaces/current/privacy/exportAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X POST "http://localhost:8000/api/v1/workspaces/current/privacy/export" \ -H "X-Workspace-Id: string"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "lead_export",
"status": "pending",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
"requested_by_email": "string",
"export": {},
"scheduled_for": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"result": {
"property1": null,
"property2": null
},
"error": "string",
"created_at": "2019-08-24T14:15:22Z"
}Export Lead Data
Data-subject access request: queue a JSON file of everything stored about this person (lead, company, timeline, consents, suppressions, enrollments, emails, replies, calls with transcripts, meetings, research, enrichment, knowledge-graph facts, deliveries). Poll the request; its `export.download_url` is a signed link once built. Admins and owners (or a key with `admin`).
Get Privacy Request
Next Page