API ReferenceManagementFlows and Styles
POST
/v2/mgmt/flow/export

Export an existing flow from a project utilizing a management key.

This endpoint is used to export an existing flow from a project. The response is the JSON which includes the flow and associated screens.

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

/v2/mgmt/flow/export

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

flowIdstring

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

{
  "flow": {
    "flowId": "string",
    "metadata": {
      "name": "string",
      "description": "string",
      "componentsVersion": "string",
      "disabled": true,
      "fingerprint": true,
      "widget": true,
      "translation": {
        "enabled": true,
        "connectorId": "string",
        "sourceLanguage": "string",
        "targetLanguages": [
          "string"
        ]
      },
      "sharedInteractions": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "icon": "string",
          "subType": "string"
        }
      ]
    },
    "contents": {},
    "screens": [
      {
        "screenId": "string",
        "interactions": [
          {
            "id": "string",
            "type": "string",
            "label": "string",
            "icon": "string",
            "subType": "string"
          }
        ],
        "contents": {}
      }
    ],
    "references": {
      "connectors": {
        "property1": "string",
        "property2": "string"
      },
      "oauth": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "userAttributes": [
        "string"
      ],
      "tenantAttributes": [
        "string"
      ]
    }
  }
}

Was this helpful?

Previous

List/Search Flows

Next

Import Flow