> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gong: List Flows

> List Gong Engage flows, filtered by owner, workspace, or folder. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List Gong Engage flows, filtered by owner, workspace, or folder.

> [!NOTE]
>
> Tool ID: `gong_list_flows`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_list_flows',
  {
    "flowOwnerEmail": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_flows --input '{
  "flowOwnerEmail": "jane.doe@example.com"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "flows": [
      {
        "id": "id_123",
        "name": "Example",
        "folderId": "folder_123"
      }
    ]
  }
}
```

Use `deepline describe gong_list_flows --json` for the latest machine-readable contract.

## Input reference

Engage flows have the following visibility types: \* Company: visible to everyone in the company, can only be edited by users with edit permissions. \* Personal: reps can set up their own flows which are only available to them. \* Shared: reps can share a flow with other reps. Those reps can then add leads to the flow. This endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowEmailOwner parameter. Alternatively this endpoint can return the flows most recently assigned by the user. When accessed through a Bearer token authorization method, use the 'api:flows:read' scope.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.flowOwnerEmail` | `string` | Yes | — | Email of the Gong user whose personal flows and flows shared with the user you want to return. |
| `payload.cursor` | `string` | No | — | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. |
| `payload.workspaceId` | `string` | No | — | Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace. |
| `payload.folderId` | `string` | No | — | Optional Folder identifier, if supplied the API will return only the flows belonging to this particular folder. |
| `payload.mostRecentlyAssigned` | `boolean` | No | — | Optional flag, if supplied the API will return only the most recently assigned flows capped at 20. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Engage flows have the following visibility types: * Company: visible to everyone in the company, can only be edited by users with edit permissions. * Personal: reps can set up their own flows which are only available to them. * Shared: reps can share a flow with other reps. Those reps can then add leads to the flow. This endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowEmailOwner parameter. Alternatively this endpoint can return the flows most recently assigned by the user. When accessed through a Bearer token authorization method, use the 'api:flows:read' scope.",
    "properties": {
      "flowOwnerEmail": {
        "type": "string",
        "description": "Email of the Gong user whose personal flows and flows shared with the user you want to return."
      },
      "cursor": {
        "type": "string",
        "description": "When paging is needed, provide the value supplied by the previous API call to bring the following page of records."
      },
      "workspaceId": {
        "type": "string",
        "description": "Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace."
      },
      "folderId": {
        "type": "string",
        "description": "Optional Folder identifier, if supplied the API will return only the flows belonging to this particular folder."
      },
      "mostRecentlyAssigned": {
        "type": "boolean",
        "description": "Optional flag, if supplied the API will return only the most recently assigned flows capped at 20."
      }
    },
    "required": [
      "flowOwnerEmail"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.requestId` | `string` | No | — | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. |
| `result.data.records` | `object` | No | — | Information about the number of records that match the requested filter. |
| `result.data.records.totalRecords` | `integer` | No | — | Total number of records. Format: `int32`. |
| `result.data.records.currentPageSize` | `integer` | No | — | Number of records in the current page. Format: `int32`. |
| `result.data.records.currentPageNumber` | `integer` | No | — | Current page number. Format: `int32`. |
| `result.data.records.cursor` | `string` | No | — | Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records. |
| `result.data.flows` | `array` | No | — | A list, in which each item specifies one Flow. |
| `result.data.flows[].id` | `string` | No | — | The id of the flow |
| `result.data.flows[].name` | `string` | No | — | The name of the flow |
| `result.data.flows[].folderId` | `string` | No | — | The id of the folder this flow is under |
| `result.data.flows[].folderName` | `string` | No | — | The name of the folder this flow is under |
| `result.data.flows[].visibility` | `"Company" \| "Personal" \| "Shared"` | No | — | The flow visibility type Allowed: `Company`, `Personal`, `Shared`. |
| `result.data.flows[].creationDate` | `string` | No | — | Creation time of the flow in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). |
| `result.data.flows[].exclusive` | `boolean` | No | — | indicates whether a prospect in this flow can be added to other flows |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
          },
          "records": {
            "type": "object",
            "description": "Information about the number of records that match the requested filter.",
            "properties": {
              "totalRecords": {
                "type": "integer",
                "description": "Total number of records.",
                "format": "int32"
              },
              "currentPageSize": {
                "type": "integer",
                "description": "Number of records in the current page.",
                "format": "int32"
              },
              "currentPageNumber": {
                "type": "integer",
                "description": "Current page number.",
                "format": "int32"
              },
              "cursor": {
                "type": "string",
                "description": "Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records."
              }
            },
            "additionalProperties": false
          },
          "flows": {
            "type": "array",
            "description": "A list, in which each item specifies one Flow.",
            "items": {
              "type": "object",
              "description": "A list, in which each item specifies one Flow.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The id of the flow"
                },
                "name": {
                  "type": "string",
                  "description": "The name of the flow"
                },
                "folderId": {
                  "type": "string",
                  "description": "The id of the folder this flow is under"
                },
                "folderName": {
                  "type": "string",
                  "description": "The name of the folder this flow is under"
                },
                "visibility": {
                  "type": "string",
                  "description": "The flow visibility type",
                  "enum": [
                    "Company",
                    "Personal",
                    "Shared"
                  ]
                },
                "creationDate": {
                  "type": "string",
                  "description": "Creation time of the flow in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)."
                },
                "exclusive": {
                  "type": "boolean",
                  "description": "indicates whether a prospect in this flow can be added to other flows"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Gong provider guide](https://deepline.com/docs/providers/gong/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.