コンテンツにスキップ
Authrim

List Flow definitions.

GET
/api/admin/flows
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/flows?kind=login&status=draft&page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

Lists tenant Flow definitions with pagination and optional filters for Flow kind, status, and text search. Deleted Flows are not returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
kind

Built-in Flow kind or a custom kind prefixed with custom:.

string
/^(login|registration|approve|account|custom:[a-z0-9][a-z0-9_-]{0,63})$/
status
string
Allowed values: draft published disabled
search
string
page
integer
default: 1 >= 1
limit
integer
default: 20 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Flow list response.

Media type application/json
object
flows
required
Array<object>
object
id
required
string
tenant_id
required
string
slug
required
string
name
required
string
display_name
required
string
description
required
string | null
template_id
required
string | null
kind
required

Built-in Flow kind or a custom kind prefixed with custom:.

string
/^(login|registration|approve|account|custom:[a-z0-9][a-z0-9_-]{0,63})$/
status
required
string
Allowed values: draft published disabled
editor
required
One of:
object
nodes
required
Array<object>
object
id
required
string
type
required
string
title
string
position
object
x
number
y
number
key
additional properties
config
object
key
additional properties
data
object
key
additional properties
key
additional properties
edges
required
Array<object>
object
id
required
string
source
required
string
target
required
string
source_handle
string
target_handle
string
label
string
data
object
key
additional properties
key
additional properties
viewport
object
x
number
y
number
zoom
number
key
additional properties
key
additional properties
runtime
required
One of:
object
flow_kind
required

Built-in Flow kind or a custom kind prefixed with custom:.

string
/^(login|registration|approve|account|custom:[a-z0-9][a-z0-9_-]{0,63})$/
flow_id
string
flow_version_id
string
ui
required
object
steps
required
Array<object>
object
key
additional properties
key
additional properties
capabilities
Array<object>
object
key
additional properties
runtime_bindings
object
key
additional properties
protocol_context
object
key
additional properties
key
additional properties
published_version_id
required
string | null
is_active
required
boolean
is_builtin
required
boolean
created_by
required
string | null
created_at
required
integer format: int64
updated_by
required
string | null
updated_at
required
integer format: int64
key
additional properties
pagination
required
object
page
required
integer
>= 1
limit
required
integer
>= 1 <= 100
total
required
integer
total_pages
required
integer
key
additional properties
key
additional properties
Example 
{
  "flows": [
    {
      "id": "flow_01HR0X",
      "tenant_id": "default",
      "slug": "login-flow",
      "name": "Login Flow",
      "display_name": "Login Flow",
      "description": "Passwordless login flow for browser users.",
      "kind": "login",
      "status": "draft",
      "editor": {
        "nodes": [],
        "edges": []
      },
      "runtime": {
        "flow_kind": "login",
        "flow_id": "flow_01HR0X",
        "ui": {
          "steps": []
        }
      },
      "published_version_id": null,
      "is_active": true,
      "is_builtin": false,
      "created_by": "admin_123",
      "created_at": 1770000000,
      "updated_by": "admin_123",
      "updated_at": 1770000000
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}