Get flows

GET https://{tenantDomain}/api/v2/flows

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Flows.ListAsync(
            new ListFlowsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Hydrate = new List<string>(){
                    "form_count",
                }
                ,
                Synchronous = true
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.FlowsListRequest{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Synchronous: management.Bool(
            true,
        ),
    }
    client.Flows.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.flows.requests.ListFlowsRequestParameters;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.flows().list(
            ListFlowsRequestParameters
                .builder()
                .hydrate(
                    Arrays.asList("form_count")
                )
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .synchronous(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Flows\Requests\ListFlowsRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->flows->list(
    new ListFlowsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'hydrate' => [
            'form_count',
        ],
        'synchronous' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.flows.list(
    page=1,
    per_page=1,
    include_totals=True,
    hydrate=[
        "form_count"
    ],
    synchronous=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.flows.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  hydrate: ["form_count"],
  synchronous: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        synchronous: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        synchronous: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/flows \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "executed_at": "2023-12-25"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · integer

Page index of the results to return. First page is 0.

Required range: 0 <= x <= 1000

per_page · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

hydrate · enum<string>[]

hydration param

Available options: form_count

Maximum string length: 50

synchronous · boolean

flag to filter by sync/async flows

Response

200

application/json

Flows successfully retrieved.

object[]

object

id · string<flow-id> · required

Maximum string length: 30

name · string · required

Required string length: 1 - 150

created_at · string<date-time> · required

updated_at · string<date-time> · required

executed_at · string<date>