List flow definitions
Retrieves a list of all flow definitions. This endpoint can be used to view existing flow definitions and their configurations.
Retrieves a list of all flow definitions. This endpoint can be used to view existing flow definitions and their configurations.
Authorization
oauth2 flow_definitions.readIn: header
Scope: flow_definitions.read
Query Parameters
Maximum number of items to return.
Token for fetching the next page of results.
Obtain this value from next_page_token in the previous response.
Omit to start from the beginning.
Its format is opaque and may change between releases.
The project id to filter by.
Filter flow definitions by purpose (e.g., registration, login).
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/flow_definitions?project_id=river-8421"{ "flow_definitions": [ { "id": "fd_123abc456def", "name": "standard-login", "project_id": "proj_789ghi012jkl", "schema_uri": "https://raw.githubusercontent.com/zitadel/nextgen/refs/tags/schema/v1.0.0/api/openapi/endpoints/schemas/flow-definition.yaml", "status": "active", "created_at": "2020-01-28T14:25:39.123456Z", "updated_at": "2020-01-28T14:25:39.123456Z" } ], "next_page_token": "v1.dGhpcyBpcyBvcGFxdWU.SflKxwRJSMeKKF2QT4fw"}{ "code": "string", "message": "string", "details": {}}{ "code": "string", "message": "string", "details": {}}Flow Definitions
OpenAPI operations for flow definition templates.
Create a new flow definition POST
Creates a new flow definition. Flow definitions are templates that define the sequence of steps (capabilities) for a particular user journey (e.g., registration, login, password reset). Flow definitions are created based on the flow definition schema, which includes the flow's purpose, audience, and the steps involved.