Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Power Platform
  4. API Docs
  5. getFlows
Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

powerplatform.getFlows

powerplatform logo
Viewing docs for Power Platform v0.3.3
published on Monday, May 18, 2026 by rpothin
Schema (JSON)
rpothin/pulumi-powerplatform

    Lists Cloud Flows in a Power Platform environment by querying the Dataverse workflow table (category=5). This approach works with service principal credentials and does not require a per-user Power Automate license. Returns the first page of results; use the ’top’ parameter to control page size. Note: the service principal must be an Application User with read access to the workflow entity in Dataverse, and will see all flows visible to that principal (not a user-scoped view).

    Using getFlows

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFlows(args: GetFlowsArgs, opts?: InvokeOptions): Promise<GetFlowsResult>
function getFlowsOutput(args: GetFlowsOutputArgs, opts?: InvokeOptions): Output<GetFlowsResult>
    def get_flows(environment_id: Optional[str] = None,
              filter: Optional[str] = None,
              select: Optional[Sequence[str]] = None,
              top: Optional[int] = None,
              opts: Optional[InvokeOptions] = None) -> GetFlowsResult
def get_flows_output(environment_id: pulumi.Input[Optional[str]] = None,
              filter: pulumi.Input[Optional[str]] = None,
              select: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
              top: pulumi.Input[Optional[int]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetFlowsResult]
    func GetFlows(ctx *Context, args *GetFlowsArgs, opts ...InvokeOption) (*GetFlowsResult, error)
func GetFlowsOutput(ctx *Context, args *GetFlowsOutputArgs, opts ...InvokeOption) GetFlowsResultOutput

    > Note: This function is named GetFlows in the Go SDK.

    public static class GetFlows 
{
    public static Task<GetFlowsResult> InvokeAsync(GetFlowsArgs args, InvokeOptions? opts = null)
    public static Output<GetFlowsResult> Invoke(GetFlowsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFlowsResult> getFlows(GetFlowsArgs args, InvokeOptions options)
public static Output<GetFlowsResult> getFlows(GetFlowsArgs args, InvokeOptions options)

    fn::invoke:
  function: powerplatform:getFlows
  arguments:
    # arguments dictionary
    data "powerplatform_getflows" "name" {
    # arguments
}

    The following arguments are supported:

    EnvironmentId string
    The ID of the environment to list flows for.
    Filter string
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    Select List<string>
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    Top int
    Maximum number of flows to return ($top). Use to limit large result sets.
    EnvironmentId string
    The ID of the environment to list flows for.
    Filter string
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    Select []string
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    Top int
    Maximum number of flows to return ($top). Use to limit large result sets.
    environment_id string
    The ID of the environment to list flows for.
    filter string
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    select list(string)
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    top number
    Maximum number of flows to return ($top). Use to limit large result sets.
    environmentId String
    The ID of the environment to list flows for.
    filter String
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    select List<String>
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    top Integer
    Maximum number of flows to return ($top). Use to limit large result sets.
    environmentId string
    The ID of the environment to list flows for.
    filter string
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    select string[]
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    top number
    Maximum number of flows to return ($top). Use to limit large result sets.
    environment_id str
    The ID of the environment to list flows for.
    filter str
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    select Sequence[str]
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    top int
    Maximum number of flows to return ($top). Use to limit large result sets.
    environmentId String
    The ID of the environment to list flows for.
    filter String
    Additional OData $filter clause appended to the base 'category eq 5' filter with 'and'. Example: "statecode eq 1" to return only active flows.
    select List<String>
    Additional Dataverse workflow columns to include in the response, merged with the required columns (workflowid, name, statecode).
    top Number
    Maximum number of flows to return ($top). Use to limit large result sets.

    getFlows Result

    The following output properties are available:

    Flows List<FlowSummary>
    The list of Cloud Flows.
    TotalRowsCount int
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    TotalRowsCountLimitExceeded bool
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    Flows []FlowSummary
    The list of Cloud Flows.
    TotalRowsCount int
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    TotalRowsCountLimitExceeded bool
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    flows list(object)
    The list of Cloud Flows.
    total_rows_count number
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    total_rows_count_limit_exceeded bool
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    flows List<FlowSummary>
    The list of Cloud Flows.
    totalRowsCount Integer
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    totalRowsCountLimitExceeded Boolean
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    flows FlowSummary[]
    The list of Cloud Flows.
    totalRowsCount number
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    totalRowsCountLimitExceeded boolean
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    flows Sequence[FlowSummary]
    The list of Cloud Flows.
    total_rows_count int
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    total_rows_count_limit_exceeded bool
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).
    flows List<Property Map>
    The list of Cloud Flows.
    totalRowsCount Number
    Total number of flows matching the query filter (from @odata.count). Zero when the count annotation is absent.
    totalRowsCountLimitExceeded Boolean
    True when the total row count exceeded the Dataverse limit (@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded).

    Supporting Types

    FlowSummary

    DisplayName string
    The display name of the flow. Identical to name when sourced from Dataverse.
    Id string
    The unique identifier (workflowid GUID) of the flow.
    Name string
    The display name of the flow (maps to the Dataverse workflow name attribute).
    StateCode int
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    DisplayName string
    The display name of the flow. Identical to name when sourced from Dataverse.
    Id string
    The unique identifier (workflowid GUID) of the flow.
    Name string
    The display name of the flow (maps to the Dataverse workflow name attribute).
    StateCode int
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    display_name string
    The display name of the flow. Identical to name when sourced from Dataverse.
    id string
    The unique identifier (workflowid GUID) of the flow.
    name string
    The display name of the flow (maps to the Dataverse workflow name attribute).
    state_code number
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    displayName String
    The display name of the flow. Identical to name when sourced from Dataverse.
    id String
    The unique identifier (workflowid GUID) of the flow.
    name String
    The display name of the flow (maps to the Dataverse workflow name attribute).
    stateCode Integer
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    displayName string
    The display name of the flow. Identical to name when sourced from Dataverse.
    id string
    The unique identifier (workflowid GUID) of the flow.
    name string
    The display name of the flow (maps to the Dataverse workflow name attribute).
    stateCode number
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    display_name str
    The display name of the flow. Identical to name when sourced from Dataverse.
    id str
    The unique identifier (workflowid GUID) of the flow.
    name str
    The display name of the flow (maps to the Dataverse workflow name attribute).
    state_code int
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.
    displayName String
    The display name of the flow. Identical to name when sourced from Dataverse.
    id String
    The unique identifier (workflowid GUID) of the flow.
    name String
    The display name of the flow (maps to the Dataverse workflow name attribute).
    stateCode Number
    The state of the flow: 0=Draft/Off, 1=Activated/On, 2=Suspended.

    Package Details

    Repository
    powerplatform rpothin/pulumi-powerplatform
    License
    MIT
    powerplatform logo
    Viewing docs for Power Platform v0.3.3
    published on Monday, May 18, 2026 by rpothin
    Schema (JSON)
    rpothin/pulumi-powerplatform

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial