Engage flow folders 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 flow folders which are only available to them.
Shared: reps can share a flow folder with other reps. Those reps can then add flows to the flow folder.
This endpoint returns all company flow folders, together with personal flow folders and flow folders shared with the user specified in the flowEmailOwner parameter.
When accessed through a Bearer token authorization method, use the 'api:flows:read' scope.
Email of the Gong user whose personal flows folders and flows folders shared with the user you want to return.
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
Optional folder identifier, if supplied the API will return only this folder and the child folders of this folder.
Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Information about the number of records that match the requested filter.
Total number of records.
Number of records in the current page.
Current page number.
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.
A list, in which each item specifies one Flow.
A list, in which each item specifies one Flow.
The id of the flow
The name of the flow
The id of the folder this flow is under
The name of the folder this flow is under
The flow visibility type
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).
indicates whether a prospect in this flow can be added to other flows
Malformed request
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Unauthorized
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Forbidden
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
API request limit exceeded
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Failed to complete the operation due to an unexpected error
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.