Get an Instance

Gets an Instance by ID. The Instance ID can be read off the instance object, or copied from the URL of the instance.


Permissions Required

You must have Find permissions to the Instance for this request to succeed.

Method Signature

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


idstringThe id of the Instance to get
callback(err?: Error, instance: Instance) => anyOptional The callback
returnsInstanceThe requested Instance


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

const catalytic = new CatalyticClient();

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