planning toolset
export_data
Export a CSV. Starts a CSV export of posts, a post's voters, users or companies, built in the background. Export a saved view (view) or describe it (filter, query, sort, columns; voters need post). Returns at once with an export ID; get_export reports progress and gives a signed download link. With notify (default true) you're emailed when it's ready. Managers and owners.
- Toolset
- planning
- Who can call it
- OwnersManagersAPI keys
- REST
POST /api/v1/w/{workspace}/exports- Behavior
- changes dataaccepts idempotency_key
Input
| Field | Type | Description |
|---|---|---|
kindrequired | one of: posts, voters, users, companies | |
view | string | The view's ID (viw_…) or name. |
filter | object | posts and roadmap: the post filter DSL (as search_posts). users: segment rules over user and company fields (as save_segment). companies take no filter; use query. |
query | string | |
sort | string | posts: trending, top, new, recently_updated, status_changed. users: newest, name, last_active. companies: name, mrr. roadmap: score, impact, effort, votes, created, added, manual. |
post | string | voters: the post (ID or slug). |
columns | array of string | Columns in order. posts: title, board, category, status, votes, comments, owner, eta, tags, author, created_at, updated_at, url, custom.<key>. users: name, email, external_id, companies, votes, posts, comments, last_active_at, created_at, attr.<key>. companies: name, external_id, mrr, renewal_date, renewal_risk, account_owner, user_count, created_at. voters (exports): post, name, email, companies, mrr, priority, note, voted_at. roadmap: title, status, board, category, owner, tags, votes, comments, mrr_at_stake, factors, impact, effort, score (factors = one column per scoring factor). Omit for sensible defaults. |
notify | boolean | Email you the link when it's ready. Default: true. |
idempotency_key | string | Retry-safe key. Repeating a call with the same key returns the first result. |
Output
| Field | Type | Description |
|---|---|---|
idrequired | string | |
kindrequired | one of: posts, voters, users, companies | |
statusrequired | one of: pending, running, complete, failed | |
rowsrequired | integer | Rows written so far, or in total once complete. |
errorrequired | string or null | |
created_atrequired | string (date-time) | |
completed_atrequired | string (date-time) or null | |
expires_atrequired | string (date-time) or null | When the file is deleted. |
download_urlrequired | string (uri) or null | Signed link to the CSV, valid for 15 minutes; call get_export again for a new one. |
admin_urlrequired | string (uri) |
Calling it
// MCP: tools/call
{ "name": "export_data", "arguments": {"kind":"<one of: posts, voters, users, companies>"} }
// Typed client
await carechannel.export_data({"kind":"<one of: posts, voters, users, companies>"});