---
title: "How to fetch your list of flows using Flowbox's API"
url: "https://kb.getflowbox.com/en/article/how-to-fetch-your-list-of-flows-using-flowboxs-api"
language: "en"
last_updated: "2026-06-03T12:54:58.842Z"
---

# How to fetch your list of flows using Flowbox's API

This guide will walk you through the process of retrieving flows using Flowbox's API.

## Prerequisites

Before you start, ensure you have the following:

-   **API key**: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.

## API Endpoint

To retrieve the list of flows in your Flowbox account, you need to send a GET request to the following endpoint:

```
https://external-api.getflowbox.com/v2/flows
```

> You can find more information and make test calls in our [Swaggerhub page](https://app.swaggerhub.com/apis-docs/FlowboxAB/External-API/v2#/External%20API/GetFlows).

## Required Parameters

| **Parameter** | **Type** | **Location** | **Description** |
| --- | --- | --- | --- |
| `api-key` | string | header | Your API authentication key. Must be included in every request. |

## Optional Parameters

| Parameter | Type | Location | Description |
| --- | --- | --- | --- |
| `fields` | string | query | Comma-separated list of additional fields to include in each flow object. Accepted values: `deleted`, `embedVersion`, `isMasterFlow`. |

## Example API Request

Here is an example request with both required and optional parameters:

```
curl -X 'GET' \  
'https://external-api.getflowbox.com/v2/flows?fields=embedVersion,isMasterFlow' \   
-H 'accept: application/json' \   
-H 'api-key: INSERT_API_KEY_HERE'
```

### Response:

The response will be a JSON containing the flow information retrieved based on the parameters you provided.

### **JSON returned:**

**Root:**

| **Field** | **Type** | **Description** |
| --- | --- | --- |
| `status` | string | Request status. One of:`"success"`,`"error"`. |
| `data.flows` | array | List of Flow objects. See *Flow object* table below. |

**Flow** (object):

| **Field** | **Type** | **Description** |
| --- | --- | --- |
| `key` | string | Key of the Flow. |
| `name` | string | Name of the Flow. |
| `type` | string | Type of the Flow, One of: `static`, `product`, `tag`. |
| `embedVersion` | string | Version of the Flow published: `v1` / `v2`. Will only be present if `fields=embedVersion` is passed. |
| `deleted` | boolean | Whether or not the Flow has been deleted. Will only be present if `fields=deleted`is passed. |
| `isMasterFlow` | boolean | Whether or not the Flow is a collection flow. Will only be present if `fields=isMasterFlow`is passed. |