Get flow executions

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Flows;

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

        await client.Flows.Executions.ListAsync(
            flowId: "flow_id",
            request: new ListFlowExecutionsRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &flows.ExecutionsListRequest{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.Flows.Executions.List(
        context.TODO(),
        "flow_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.flows.executions.requests.ListFlowExecutionsRequestParameters;

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

        client.flows().executions().list(
            "flow_id",
            ListFlowExecutionsRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Flows\Executions\Requests\ListFlowExecutionsRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->flows->executions->list(
    'flow_id',
    new ListFlowExecutionsRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.flows.executions.list(
    flow_id="flow_id",
    from="from",
    take=1,
)

require "auth0"

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

client.flows.executions.list(
  flow_id: "flow_id",
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.executions.list("flow_id", {
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.flows.executions.list("flow_id", {
        from: "from",
        take: 1,
    });
}
main();

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

200

[
  {
    "id": "<string>",
    "trace_id": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "journey_id": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z"
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

flow_id · string · 必須

Flow id

Maximum string length: 30

クエリパラメータ

page · integer

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

必須範囲: x >= 0

per_page · integer

Number of results per page. Defaults to 50.

必須範囲: 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).

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100

レスポンス

200

application/json

Flow executions successfully retrieved.

Option 1 · object[]

Option 2 · object

Option 3 · object

id · string<flow-execution-id> · 必須

Flow execution identifier

Maximum string length: 30

trace_id · string · 必須

Trace id

Required string length: 1 - 50

status · string · 必須

Execution status

Required string length: 1 - 50

created_at · string<date-time> · 必須

The ISO 8601 formatted date when this flow execution was created.

updated_at · string<date-time> · 必須

The ISO 8601 formatted date when this flow execution was updated.

journey_id · string

Journey id

Required string length: 1 - 50

started_at · string<date-time>

The ISO 8601 formatted date when this flow execution started.

ended_at · string<date-time>

The ISO 8601 formatted date when this flow execution ended.