Get a flow definition by id
Get a flow definition by id
Get a flow definition by id
Authorization
oauth2 flow_definitions.readIn: header
Scope: flow_definitions.read
Path Parameters
The id returned by the POST /flow_definitions endpoint.
Query Parameters
The project id to filter by.
Response Body
application/json
application/json
curl -X GET "https://example.com/flow_definitions/fd_123abc456def?project_id=river-8421"{ "id": "fd_123abc456def", "project_id": "proj_789ghi012jkl", "flow_definition": { "name": "standard-login", "status": "active", "user_schema": "sch_01KWHF18816ZQESRCS7Z2STJ05", "purposes": { "login": "identify" }, "audience": { "app_ids": [ "app_saas" ] }, "steps": [ { "name": "identify", "fields": [ "email" ], "actions": [ { "name": "submit", "kind": "submit", "primary": true } ], "transitions": { "submit": { "target": "authenticate" }, "user_not_found": { "target": "register", "action": "switch" } } }, { "name": "authenticate", "fields": [ "password" ], "actions": [ { "name": "submit", "kind": "submit", "primary": true } ], "transitions": { "submit": { "target": "done" } } }, { "name": "done", "complete": "redirect" } ] }, "created_at": "2020-01-28T14:25:39.123456Z", "updated_at": "2020-01-28T14:25:39.123456Z"}{ "code": "string", "message": "string", "details": {}}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.
Update a flow definition by id PUT
Update a flow definition by id. This endpoint replaces the existing flow definition. If `flow_definition.status` is omitted, the current status is preserved