Get Plan
profitwell.get_plan
ActionBusiness appsconnection required
Calls the ProfitWell API with the connection's credentials.
Read one manually-added plan by its id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ProfitWell
- Secret shape
- the private API token, or {"api_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
plan_id The id of the manually-added plan to read. | string | Yes | — | — | foo_plan |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"plan_id": "foo_plan"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The plan's id. | string | — |
name The plan's display name. | string | — |
{
"id": "",
"name": ""
}See Get Plan run in a workflow.
In a technical demo we add the ProfitWell connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.