--- title: "Get Plan" method: GET path: "/plans/{plan_id}" --- # Get Plan `GET /plans/{plan_id}` Fetch a persisted plan by id. Workspace-scoped: a plan is only readable by callers in the same workspace (`user_id`) it was created in. Mismatches return 404 — not 403 — so existence isn't leaked across workspaces. ## Path parameters - `plan_id` integer, required ## Headers - `Authorization` string, nullable - `X-User-Id` string, nullable ## Cookies - `session_id` string, nullable ## Response `200` Successful Response - PlanResponse - `id` integer, required - `version` integer, required - `status` 'active' | 'applied' | 'partially_applied' | 'superseded' | 'canceled', required - `created_at` string, date-time, required - `updated_at` string, date-time, required - `payload` PlanOutput, required - `id` string, required - `title` string, nullable - `estimated_impact` string[], required - `suggestions` ConvergeApiPlanSchemaSuggestion[], required - `id` string, required - `action` 'scale-up' | 'scale-down' | 'pause' | 'activate' | 'bid' | 'rename' | 'duplicate-ad' | 'duplicate-adset' | 'duplicate-campaign', required - `platform` 'meta', required - `primary_target` ChangeTarget, required - `scope` 'campaign' | 'adset' | 'ad', required - `platform_object_id` string, required - `name` string, required - `campaign_id` string, nullable - `campaign_name` string, nullable - `adset_id` string, nullable - `adset_name` string, nullable - `summary` string, required - `rationale` string, required - `reasons` Evidence[], required - `text` string, required - `polarity` 'positive' | 'negative', required - `confidence` number, required - `impact` number, required - `viz` Viz, required — How the FE should render data behind a Suggestion. The agent declares *which* metrics to query and *how* (date range, granularity, attribution); the FE issues the insight query and renders cards/sparkline from the result. The agent never embeds pre-computed values. - `primary_metric` union, required - EventMetricSpec - `slug` string, required - `type` 'events' | 'revenue' | 'cpa' | 'roas' | 'acos' | 'sessions' | 'session_conversion_rate' | 'session_duration' | 'new_visitor_sessions' | 'new_visitor_sessions_rate' | 'avg_session_revenue' | 'bounce_rate', required - `event_name` string - `label` string, nullable - MarketingMetricSpec - `slug` string, required - `type` 'spend' | 'clicks' | 'impressions' | 'cpc' | 'cpm' | 'ctr' | 'ad_conversions' | 'ad_revenue' | 'ad_roas' | 'ad_cpa' | 'ad_acos' | 'northbeam_nv_rate', required - `conversion_name` string - `label` string, nullable - `supporting_metrics` union[] - union - EventMetricSpec - … - MarketingMetricSpec - … - `since` string, date, required - `until` string, date, required - `time_granularity` 'hour' | 'day' | 'week' | 'month', required - `attribution` ConvergeApiPlanSchemaAttribution - `model` 'direct_session' | 'first_touch' | 'first_touch_paid' | 'inv_j_shaped' | 'inv_j_shaped_paid' | 'j_shaped' | 'j_shaped_paid' | 'last_touch' | 'last_touch_paid' | 'linear' | 'top_of_funnel' | 'participation' | 'u_shaped' | 'time_decay' | 'inv_time_decay', required - `window` integer, required - `mode` 'click_time' | 'conversion_time', required - `changes` union[], required - union - DailyBudgetChange - `target` ChangeTarget, required - … - `note` string, nullable - `from_amount` number, required - `to_amount` number, required - `currency` string, required - `scope` 'campaign' | 'adset', required - `field` 'daily_budget', required - LifetimeBudgetChange - `target` ChangeTarget, required - … - `note` string, nullable - `from_amount` number, required - `to_amount` number, required - `currency` string, required - `scope` 'campaign' | 'adset', required - `field` 'lifetime_budget', required - DailySpendCapChange - `target` ChangeTarget, required - … - `note` string, nullable - `from_amount` number, required - `to_amount` number, required - `currency` string, required - `field` 'daily_spend_cap', required - `scope` 'adset', required - LifetimeSpendCapChange - `target` ChangeTarget, required - … - `note` string, nullable - `from_amount` number, required - `to_amount` number, required - `currency` string, required - `field` 'lifetime_spend_cap', required - `scope` 'campaign' | 'adset', required - BidAmountChange — Ad set bid/cost goal (`bid_amount`), in the account's major units. Backs Meta's `LOWEST_COST_WITH_BID_CAP` (bid cap) and `COST_CAP` (cost-per-result goal) bid strategies — both store their target in the ad-set-level `bid_amount` field, so a single change variant covers both. - `target` ChangeTarget, required - … - `note` string, nullable - `from_amount` number, required - `to_amount` number, required - `currency` string, required - `field` 'bid_amount', required - `scope` 'adset', required - RoasGoalChange — Ad set minimum-ROAS goal for the `LOWEST_COST_WITH_MIN_ROAS` strategy. - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'roas_average_floor', required - `scope` 'adset', required - `from_roas` number, required - `to_roas` number, required - StatusChange - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'status', required - `scope` 'campaign' | 'adset' | 'ad', required - `from` 'ACTIVE' | 'PAUSED', required - `to` 'ACTIVE' | 'PAUSED', required - NameChange - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'name', required - `scope` 'campaign' | 'adset' | 'ad', required - `name` string, required - DuplicateAdChange — Duplicate an existing ad into another adset reusing the source ad's creative - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'duplicate_ad', required - `scope` 'ad', required - `destination_adset_id` string, nullable - `status_option` 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE' - `rename_suffix` string, nullable - `rename_prefix` string, nullable - DuplicateAdsetChange — Duplicate an existing ad set — its settings and its ads. Applied by *recreating* the ad set (Meta's `/copies` can only name the copy via prefix/suffix, and name-based URL parameters freeze at first publish, so the copy must be created bearing its final name). The child ads are then duplicated into the copy reusing each source ad's creative, so post IDs carry over; the ads keep their source names and statuses. - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'duplicate_adset', required - `scope` 'adset', required - `destination_campaign_id` string, nullable - `status_option` 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE' - `rename_suffix` string, nullable - `rename_prefix` string, nullable - `budget` Budget — A monetary amount with its spend period. - … - `bid` MonetaryAmount — A currency-denominated value — major units on the wire, the ad account's currency, scaled to minor units at the Meta boundary. - … - `attribution` AttributionSetting — A Meta attribution setting, as the human-facing window pair. Translated to the ad-set-level `attribution_spec` at the applier boundary (`converge_api.plan.facebook.attribution_setting_to_spec`). Meta's valid combinations today: 1- or 7-day click, optionally with a 1-day engaged view (video) and/or a 1-day view. - … - DuplicateCampaignChange — Duplicate an existing campaign — its settings, ad sets, and ads. Applied by *recreating* the whole tree (see `DuplicateAdsetChange` for why `/copies` can't be used): the campaign is created bearing its final name, each ad set is recreated into it keeping its own name and status, and each ad is duplicated reusing the source ad's creative so post IDs carry over. - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'duplicate_campaign', required - `scope` 'campaign', required - `status_option` 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE' - `rename_suffix` string, nullable - `rename_prefix` string, nullable - `attribution` AttributionSetting — A Meta attribution setting, as the human-facing window pair. Translated to the ad-set-level `attribution_spec` at the applier boundary (`converge_api.plan.facebook.attribution_setting_to_spec`). Meta's valid combinations today: 1- or 7-day click, optionally with a 1-day engaged view (video) and/or a 1-day view. - … - `outcomes` PlanOutcomeResponse[], required - `suggestion_id` string, required - `decision` 'accepted' | 'rejected' | 'skipped' | 'follow_up', required — The user's verdict on a single suggestion at apply time. - `feedback` string, nullable, required - `success` boolean, nullable, required - `error` string, nullable, required - `agent_session_id` integer, nullable, required - `actioned_by` PlanActor - `id` integer, required - `email` string, required - `first_name` string, nullable - `last_name` string, nullable - `profile_picture_url` string, nullable - `actioned_at` string, date-time, nullable ## Other responses - `422` — Validation Error --- [API](https://skmtc.dev/runconverge/apis/fastapi.md) · [All operations](https://skmtc.dev/runconverge/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runconverge/fastapi/revisions/1452e350bd1d/schema)