---
title: "Get a list of executable workflows"
method: GET
path: "/v2/workflows"
tags: ["Individual Workflows"]
---

# Get a list of executable workflows

`GET /v2/workflows`

Get a list of workflows that can be executed

## Query parameters

- `serviceName` string
- `include` string[]

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string
- `X-Frankie-Username` string

## Response `200`

OK

- object
  - `requestId` string — The unique request identifier for the API call made.
  - `workflows` WorkflowLookup[] — Provide a set of workflow lookup objects.
    - `serviceName` string — Name of the service.
    - `workflowId` string — Unique identifier of the workflow.
    - `workflowName` string — Name of the workflow.
    - `type` string — Type of the workflow.
    - `lifecyclePhase` 'ONBOARDING' | 'MONITORING' | 'OTHER' — Specifies the lifecycle phase of the customer in which this workflow is executed: - ONBOARDING: Workflow is in the onboarding stage. - MONITORING: Workflow is in the monitoring stage. - OTHER: Workflow is in another stage.
    - `monitoringTypes` MonitoringType[] — The types of monitoring to which this workflow is subscribed. If not provided, the workflow is subscribed to all monitoring types.
    - `definition` WorkflowDefinition — Workflow definition
      - `definitionUpdatedAt` string, date-time — The date and time the workflow was last updated
      - `version` string — The version of the workflow
      - `steps` WorkflowStep[] — The steps of the workflow
        - `name` string — Name of the step (must be unique)
        - `description` string — Description of the step
        - `version` string — Version of the step
        - `type` 'BLOCKLIST' | 'DUPLICATE' | 'DECISION' | 'BRANCH' | 'MONITOR_TOGGLE' | 'OTHER' | 'KYC' | 'AML' | 'IDV' | 'START' | 'FINISH'
        - `configuration` object — Configuration for the step
        - `dependsOn` string[] — List of step names that this step depends on

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)