Search...
getPhaseInfo( )
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.
Description
Retrieves a phase by ID.
The getPhaseInfo()
function returns a Promise that resolves to the phase
with the specified ID.
This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
Syntax
function getPhaseInfo(phaseId: string): Promise<Phase>
getPhaseInfo Parameters
NAME
TYPE
DESCRIPTION
phaseId
string
ID of the phase to retrieve.
Returns
Fulfilled - Retrieved phase.
Return Type:
Promise<Phase>
NAME
TYPE
DESCRIPTION
id
string
Unique phase identifier.
name
string
Name of the phase.
Was this helpful?
Get a phase info
Copy Code
1import { Permissions, webMethod } from 'wix-web-module';2import { workflows } from 'wix-crm-backend';34export const getPhaseInfo = webMethod(Permissions.Anyone, (phaseId) => {5 return workflows.getPhaseInfo(phaseId);6});78// Returns a promise that resolves to:9// {10// name: "Phase Name",11// id: "66f6443c-884f-4b12-beae-ab864fb489db"12// }