API Reference/Management/Flows and Styles
POST
/v2/mgmt/flow/export

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
flowIdstring
curl -X POST "https://api.descope.com/v2/mgmt/flow/export" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "flowId": "string"
  }'

OK

{
  "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?

List/Search Flows POST

### 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](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/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>`

Import Flow POST

### Import a flow within a project utilizing a management key. This endpoint is used to import a flow to a project. The request items for the `flow` and `screen` this endpoint can be received from the export flow endpoint. ### See Also - See [Flow Overview](/customize/flows/) for more information on flows. - See [Manage Flows](/customize/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>`