CLI DocumentationSDK DocumentationCommunityHelpCompany

Find Workflows

Suggest Edits

Finds Workflows that match your criteria. The Workflows.Find method supports a fluent style where you can chain together your search criteria.

šŸ‘

Permissions Required

Matching Workflows will only be included in the results if you have Find permissions to that Workflow. Workflows that you do not have permissions to will be excluded from the results.

Method Signature

find(): Promise<WorkflowsPage>;
find(options: FindWorkflowOptions): Promise<WorkflowsPage>;
find(callback: (err?: Error, workflowsPage: WorkflowsPage) => any): void;
find(options: FindWorkflowOptions, callback: (err?: Error, workflowsPage: WorkflowsPage) => any): void;

Parameters

ParameterTypeDescriptionDefault
optionsFindWorkflowOptionsOptional The options options filter criteria to search by, or null to fetch all Workflows.
options.ownerstringOptional Search for Workflows owned by a specific team member. The email
address of the owner of the Workflow must match exactly, apart from casing.
options.categorystringOptional Search for Workflows in a specific category
options.querystringOptional A query string to search by. Applies to the name and description
properties of Workflows
options.pageSizenumberOptional The number of Workflows to fetch in a single WorkflowsPage response25
options.pageTokenstringOptional The nextPageToken of a previous find request, used to fetch the next set of results
callback(err?: Error, workflowsPage: WorkflowsPage) => anyOptional The callback
returnsWorkflowsPageThe requested page of Workflows

Example

/*
 * This example demonstrates listing all workflows
 */
const { CatalyticClient } = require('@catalytic/sdk');

const catalytic = new CatalyticClient();

const workflows = [];

const options = { pageSize: 25 };
let hasNextPage = true;

while (hasNextPage) {
    const workflowsPage = await catalytic.workflows.find(options);
    workflows.push(...workflowsPage.workflows);
    if (workflowsPage.nextPageToken) {
        options.pageToken = workflowsPage.nextPageToken;
    } else {
        hasNextPage = false;
    }
}

workflows.forEach(workflow => {
    console.log(workflow.name);
});

Updated over 3 years ago