List flows

Who can call it: Any signed-in member of the workspace.

Send X-Sahl-Environment: sandbox or production (or the environment query parameter) to choose the workspace. Without it, no environment filter is applied. production is refused with 403 production_requires_paid_plan when the subscription is cancelled or suspended.

Auth: dashboard session (Authorization: Bearer <access token>). Not available with a partner API key.

List flows

cURL

curl --request GET \
  --url https://app.sahlfinancial.com/api/v1/flows \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "d6a3f9b8-2c5e-4170-b8d1-4e0a7c3f5b29",
      "tenant_id": "0b6f5a3e-7c1d-4e0a-9d2f-3a1c5e8b7f10",
      "name": "Salaried borrower",
      "description": null,
      "use_case": "lending",
      "kind": "kyc",
      "country": "MA",
      "nodes": [
        {
          "id": "start",
          "type": "start",
          "position": {
            "x": 0,
            "y": 0
          },
          "data": {
            "label": "Start"
          }
        },
        {
          "id": "end",
          "type": "end",
          "position": {
            "x": 240,
            "y": 0
          },
          "data": {
            "label": "End"
          }
        }
      ],
      "edges": [
        {
          "id": "e1",
          "source": "start",
          "target": "end"
        }
      ],
      "version": 1,
      "is_published": false,
      "status": "draft",
      "environment": "sandbox",
      "created_at": "2026-10-07T09:14:22Z",
      "updated_at": "2026-10-07T09:14:22Z",
      "published_at": null,
      "country_support": null
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 20
}

Authorizations

Authorization · string · header · required

The access token (JWT) of a signed-in console user, from POST /v1/auth/login. It lasts 30 minutes. It is not an API key: a partner API key is refused here. There is no cookie.

Headers

X-Sahl-Environment · string | null

Query Parameters

page · integer · default: 1

Required range: x >= 1

page_size · integer · default: 20

Required range: 1 <= x <= 100

use_case · string | null

kind · string | null

Filter by flow kind: 'kyc' or 'kyb'

country · string | null

Filter by ISO alpha-2 country

status · string | null

environment · string | null

Response

200

application/json

OK

items · object[] · required

Show child attributes

total · integer · required

page · integer · required

page_size · integer · required