--- title: "Get Plan" method: GET path: "/plans/{plan_id}" --- # Get Plan `GET /plans/{plan_id}` ## Request - Base URL: `https://app.runconverge.com/api` - URL: `https://app.runconverge.com/api/plans/{plan_id}` - Auth: none declared 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` Plan, required - `id` string, required - `title` string, nullable - `estimated_impact` string[], required - `suggestions` ConvergeApiPlanSchemaSuggestion[], required - `id` string, required: Unique within the plan. - `action` 'scale-up' | 'scale-down' | 'pause' | 'activate' | 'bid' | 'rename' | 'duplicate-ad' | 'duplicate-adset' | 'duplicate-campaign' | 'landing-url', 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' | 'neutral', 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 - `currency` string, required - `from_amount` number, required - `to_amount` number, required - `scope` 'campaign' | 'adset', required - `field` 'daily_budget', required - LifetimeBudgetChange - `target` ChangeTarget, required - … - `note` string, nullable - `currency` string, required - `from_amount` number, required - `to_amount` number, required - `scope` 'campaign' | 'adset', required - `field` 'lifetime_budget', required - DailySpendCapChange - `target` ChangeTarget, required - … - `note` string, nullable - `currency` string, required - `from_amount` number, nullable, required - `to_amount` number, nullable, required - `field` 'daily_spend_cap', required - `scope` 'adset', required - LifetimeSpendCapChange - `target` ChangeTarget, required - … - `note` string, nullable - `currency` string, required - `from_amount` number, nullable, required - `to_amount` number, nullable, 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 - `currency` string, required - `from_amount` number, required - `to_amount` number, 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 - LandingUrlChange: Change an ad's landing page URL — the destination "Website URL". Applied by minting a new creative from the source's spec with the link replaced (or rebuilt from the post a post-ID ad wraps), then pointing the ad at it. The new creative gets a new page post, so accumulated social proof (likes, comments) does not carry. - `target` ChangeTarget, required - … - `note` string, nullable - `field` 'landing_url', required - `scope` 'ad', required - `from_url` string, required - `to_url` 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 - `landing_url` 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. - … - `landing_url` string, nullable - 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', required: The user's verdict on a single suggestion at apply time. - `feedback` string, nullable, required - `success` boolean, nullable, required - `error` string, nullable, required - `changes` PlanChangeApplicationResponse[] - `change_index` integer, required - `field` string, required - `platform_object_id` string, required - `outcome` 'applied' | 'failed' | 'aborted' | 'skipped', required: What became of a single `Change` in an accepted suggestion. - `error` string, nullable, required - `override` union, required: A `ChangeEdit` as persisted on `plan_change_applications.override`. Concrete wrapper so the union can back a `PydanticSchema` column, which needs a model class rather than an `Annotated` alias. - ValueEdit: Retune the value the agent proposed, leaving the change itself alone. - `kind` 'value' - `value` union, required - MonetaryOverride: Operator edit of a monetary change's target, in minor currency units. TODO: migrate this from minor units (`to_cents`) to major units (`to_amount`) to be consistent with `MonetaryChange`, which now carries major units. - … - SpendCapOverride: Operator edit of a spend-cap change's target. Like `SpendCapChange`, the target may be empty: `to_cents: null` removes the cap. Required with no default, so an omitted value can't be read as a removal. - … - RoasGoalOverride: Operator edit of a ROAS-goal change's target (human-facing multiplier). - … - DuplicateAdOverride - … - DuplicateAdsetOverride - … - DuplicateCampaignOverride - … - ReplaceEdit: Swap the change for a different one on the same object. - `kind` 'replace', required - `change` union, required - DailyBudgetChange - … - LifetimeBudgetChange - … - DailySpendCapChange - … - LifetimeSpendCapChange - … - 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. - … - RoasGoalChange: Ad set minimum-ROAS goal for the `LOWEST_COST_WITH_MIN_ROAS` strategy. - … - StatusChange - … - NameChange - … - LandingUrlChange: Change an ad's landing page URL — the destination "Website URL". Applied by minting a new creative from the source's spec with the link replaced (or rebuilt from the post a post-ID ad wraps), then pointing the ad at it. The new creative gets a new page post, so accumulated social proof (likes, comments) does not carry. - … - DuplicateAdChange: Duplicate an existing ad into another adset reusing the source ad's creative - … - 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. - … - 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. - … - DropEdit: Leave the change out of the push. A suggestion must keep one. - `kind` 'drop', 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 ## Changes - **2026-10-02** `da98d7824f8c`: 1 warning - added the new `neutral` enum value to the `payload/suggestions/items/reasons/items/polarity` response property for the response status `200` - **2026-10-02** `b5568b902b98`: 1 breaking, 4 info - added `#/components/schemas/SpendCapOverride` to the `outcomes/items/changes/items/override/anyOf[subschema #1: StoredChangeEdit]/oneOf[subschema #1: ValueEdit]/value` response property `oneOf` list for the response status `200` - mapped value for discriminator key `daily_spend_cap` changed from `#/components/schemas/MonetaryOverride` to `#/components/schemas/SpendCapOverride` for `outcomes/items/changes/items/override/anyOf[subschema #1: StoredChangeEdit]/oneOf[subschema #1: ValueEdit]/value` response property for the response status `200` - mapped value for discriminator key `lifetime_spend_cap` changed from `#/components/schemas/MonetaryOverride` to `#/components/schemas/SpendCapOverride` for `outcomes/items/changes/items/override/anyOf[subschema #1: StoredChangeEdit]/oneOf[subschema #1: ValueEdit]/value` response property for the response status `200` - removed the `daily_spend_cap` enum value from the `outcomes/items/changes/items/override/anyOf[subschema #1: StoredChangeEdit]/oneOf[subschema #1: ValueEdit]/value/oneOf[subschema #1: MonetaryOverride]/field` response property for the response status `200` - …1 more - …earlier changes not shown [Operation history](https://skmtc.dev/runconverge/apis/runconverge-api/changes/plans/:plan_id/get.md) --- [API](https://skmtc.dev/runconverge/apis/runconverge-api.md) - [All operations](https://skmtc.dev/runconverge/apis/runconverge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runconverge/apis/runconverge-api/revisions/f723e951cc0b?raw)