listPhasesInfo( )


Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.

Retrieves a list of a workflow's phases.

The listPhasesInfo() function returns a Promise that resolves to a list containing information about the specified workflow's phases.

Use the options parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their "id", "name", and "position". If no limit parameter is passed, the first 50 cards are returned. Sort order defaults to by "position" ascending.

This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.

Method Declaration
Copy
Method Parameters
workflowIdstringRequired

ID of the workflow to retrieve phases from.


optionsListOptions

Options to use when retrieving the list of phases.

Returns
Return Type:Promise<PhaseList>
Did this help?