Get flow executions

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

Go

Go

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,
    )
}

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>'

import requests

url = "https://{tenantDomain}/api/v2/flows/{flow_id}/executions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/flows/{flow_id}/executions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/flows/{flow_id}/executions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/flows/{flow_id}/executions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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.