Gong: List Flows

List Gong Engage flows (/v2/flows).

Tool ID: gong_list_flows

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

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

deepline tools execute gong_list_flows --input '{
  "flowOwnerEmail": "jane.doe@example.com"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "flows": [
      {
        "id": "id_123",
        "name": "Example",
        "folderId": "folder_123"
      }
    ]
  }
}

Use deepline tools get 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.

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).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation