Get workflow detail.

GEThttps://staging.softsolz.uk/api/v1/services/workflows/workflows/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idstringWorkflow id.

namestringWorkflow name.

descriptionstring | nullOptional description.

statusstringSchedule status.

trigger_typestringHow the workflow runs.

cron_expressionstring | null5-field cron expression (when trigger_type is schedule).

timezonestringSchedule timezone.

visibilitystringWho can see/edit it.

stepsarray of objectsOrdered step definitions.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.workflows.getWorkflow('<id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "trigger_type": "string",
    "cron_expression": "string",
    "timezone": "string",
    "visibility": "string",
    "steps": [],
    "created_at": "string",
    "updated_at": "string"
  }
}