Get a flow execution

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Flows.Executions.GetAsync(
            flowId: "flow_id",
            executionId: "execution_id",
            request: new GetFlowExecutionRequestParameters {
                Hydrate = new List<string>(){
                    "debug",
                }

            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &flows.ExecutionsGetRequest{}
    mgmt.Flows.Executions.Get(
        context.TODO(),
        "flow_id",
        "execution_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.flows.types.GetFlowExecutionRequestParameters;
import java.util.Arrays;

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

        client.flows().executions().get(
            "flow_id",
            "execution_id",
            GetFlowExecutionRequestParameters
                .builder()
                .hydrate(
                    Arrays.asList("debug")
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Flows\Executions\Requests\GetFlowExecutionRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->flows->executions->get(
    'flow_id',
    'execution_id',
    new GetFlowExecutionRequestParameters([
        'hydrate' => [
            'debug',
        ],
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.flows.executions.get(
    flow_id="flow_id",
    execution_id="execution_id",
    hydrate=[
        "debug"
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.flows.executions.get(
  flow_id: "flow_id",
  execution_id: "execution_id",
  hydrate: ["debug"]
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.flows.executions.get("flow_id", "execution_id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.flows.executions.get("flow_id", "execution_id", {});
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/flows/{flow_id}/executions/{execution_id} \
  --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>",
  "debug": {},
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

flow_id · string · required

Flow id

Maximum string length: 30

execution_id · string · required

Flow execution id

Maximum string length: 30

Query Parameters

hydrate · enum<string>[]

Hydration param

Available options: debug

Maximum string length: 5

Response

200

application/json

Flow execution successfully retrieved.

id · string<flow-execution-id> · required

Flow execution identifier

Maximum string length: 30

trace_id · string · required

Trace id

Required string length: 1 - 50

status · string · required

Execution status

Required string length: 1 - 50

created_at · string<date-time> · required

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

updated_at · string<date-time> · required

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

journey_id · string

Journey id

Required string length: 1 - 50

debug · object

Flow execution debug.

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.