Get flows

Retrieve all flows available per environment.

Use this endpoint to retrieve all flows available in your environment. The response provides essential metadata for each flow.

Endpoint

GET /api/v1/flows/{environment}

Path parameters

Parameter	Type	Required	Description
environment	String	Yes	The logical environments ( live or staging )

Query parameters

Parameter	Type	Required	Description
page	number	No	Page number (1-based, default: 1)
size	number	No	Number of items per page (default: 20, max: 100)

Request

No request body is required for this endpoint.

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Returns an array of flow objects with minimal metadata.

Response parameters

Parameter	Type	Description
content	array	Array of flow objects
content[].id	string	Unique identifier for the flow
content[].name	string	Configurable display name of the flow
content[].description	string	Configurable description of the flow's purpose
content[].version	number	Active flow version (optional, may be absent if no active deployment)
page	object	Pagination metadata
page.size	number	Number of items per page
page.number	number	Current page number (1-based)
page.totalElements	number	Total number of flows across all pages
page.totalPages	number	Total number of pages

{
  "content": [
    {
      "id": "0197c55f-5af6-7e3d-af9b-f2359b104be8",
      "name": "Document-based IDV - Capture",
      "description": "Verifies identity by capturing and checking official ID documents",
      "version": 1
    },
    {
      "id": "0197c55f-5af6-7e6g-af9b-f2359b104be8",
      "name": "Biometric authentication",
      "description": "Identity verification using unique body features instead of passwords",
      "version": 2
    }
  ],
  "page": {
    "size": 20,
    "number": 1,
    "totalElements": 25,
    "totalPages": 2
  }
}

Example

curl https://localhost:3000/api/v1/flows/live \
-H "Authorization: Bearer YOUR_API_KEY"

Notes

• Results are paginated. Use page and size query parameters to navigate through results

---