Get a Workflow

Gets a Workflow by ID. The Workflow ID can be read off of the Workflow object, or copied from the URL of the Workflow.

πŸ‘

Permissions Required

You must have Find permissions to the Workflow in order to for this request to succeed.

Method Signature

get(id: string): Promise<Workflow>;
get(id: string, callback: (err?: Error, workflow: Workflow) => any): void;

Parameters

ParameterTypeDescription
idGuidThe id of the Workflow to get
callback(err?: Error, workflow: Workflow) => anyOptional The callback
returnsWorkflowThe requested Workflow

Example

/*
 * This example demonstrates getting a Workflow by id
 */
const { CatalyticClient } = require('@catalytic/sdk');

const catalytic = new CatalyticClient();

const workflow = await catalytic.workflows.get('c9f2beec-10c0-4f2f-b4e0-1d884c7e053c');