API ReferenceManagementFlows and Styles
POST
/v1/mgmt/flow/list

List or search flows within a project utilizing a management key.

This endpoint is used to list or search flows within a project.

To list all flows, send an empty body such as: { } or { "ids": [] }.

To search for a flow or several flows, send a body with the flowIds you want to search such as { "ids": ["sign-in"] } or { "ids": ["sign-in", "sign-up"] }.

See Also

  • See Flow Overview for more information on flows.
  • See Manage Flows for more information on managing (export, import, delete, disable, enable) flows.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/flow/list

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

idsarray<string>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/flow/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "ids": [
    "string"
  ]
}'

{
  "flows": [
    {
      "id": "string",
      "version": 0,
      "name": "string",
      "description": "string",
      "dsl": {},
      "modifiedTime": "string",
      "etag": "string",
      "disabled": true,
      "translate": true,
      "translateConnectorID": "string",
      "translateSourceLang": "string",
      "translateTargetLangs": [
        "string"
      ],
      "fingerprint": true,
      "widget": true,
      "sharedInteractions": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "icon": "string",
          "subType": "string"
        }
      ]
    }
  ],
  "total": 0
}

Was this helpful?

Previous

Flow and Style Management API Overview

Next

Export Flow