ZitadelDocs

Get a flow definition by id

Get a flow definition by id

GET
/flow_definitions/{id}

Get a flow definition by id

Authorization

headerAuthorizationBearer <token>

Scope: flow_definition.read

Path Parameters

id*string

The id returned by the POST /flow_definitions endpoint.

Response Body

Flow definition found.

application/json
  1. response
id*string

Unique identifier for the flow definition.

project_id*string

Identifier of the project this flow definition belongs to.

flow_definition*

A flow definition is the server-side configuration that describes a complete authentication or identity flow. It is NOT sent to the frontend — the flow engine evaluates it and produces FlowResponse payloads (steps with capability dictionaries) for the client.

Flow definitions are created by administrators and stored in the project/team configuration hierarchy. The engine selects the matching definition based on the purpose + audience when a flow is created via POST /flow.

user_schema?|

The user schema this flow operates on: the same object GET /schemas/{id} returns. Present only when the request asked for it with expand=user_schema; null when it was requested but the referenced schema no longer resolves or the caller may not read it.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X GET 'https://example.com/flow_definitions/string'
{  "id": "string",  "project_id": "string",  "flow_definition": {    "$schema": "string",    "name": "standard-login",    "status": "active",    "user_schema": "string",    "purposes": {      "property1": "string",      "property2": "string"    },    "audience": {      "team_ids": [        "string"      ],      "app_ids": [        "string"      ]    },    "steps": [      {        "name": "string",        "fields": [],        "actions": [],        "gates": {},        "sso_providers": [],        "on_success": "create_user",        "complete": "redirect",        "transitions": {          "property1": {            "target": "string",            "action": "switch",            "purpose": "login"          },          "property2": {            "target": "string",            "action": "switch",            "purpose": "login"          }        }      }    ]  },  "user_schema": {    "id": "string",    "schema": {      "$schema": "https://json-schema.org/draft/2020-12/schema",      "objectType": "string",      "kind": "user-schema",      "metaSchema": "http://example.com",      "x-auth-methods": {        "password": {          "enabled": true        },        "passkey": {          "enabled": true        },        "magic_link": {          "enabled": true        },        "sso": {          "providers": [            "google"          ],          "enabled": true        },        "otp": {          "enabled": true        }      },      "x-identifier": "string",      "x-display": [        "string"      ],      "properties": {        "property1": {          "x-unique": "unspecified",          "x-claim": "string",          "x-audit": false,          "properties": {            "property1": {},            "property2": {}          }        },        "property2": {          "x-unique": "unspecified",          "x-claim": "string",          "x-audit": false,          "properties": {            "property1": {},            "property2": {}          }        }      }    },    "metadata": {      "created_at": "2019-08-24T14:15:22Z"    }  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}