Workflows

Get all workflows

get

Authorizations

Query parameters

startnumberoptional

The page No

Example: 0

limitnumber · min: 1 · max: 50optional

The Page Size

Example: 10

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/workflows' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

422

500

200

{
  "success": true,
  "message": "Workflows fetched successfully",
  "total": 1,
  "data": [
    {
      "id": "The Workflow ID",
      "name": "The Workflow name"
    }
  ]
}

Workflows fetched successfully

Get workflow by ID

Get workflowId from the response of the above API.

get

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/workflows/{workflowId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "Workflow fetched successfully",
  "data": {
    "id": "The Workflow ID",
    "name": "The Workflow name",
    "description": "The Workflow description",
    "isScheduled": false,
    "inputSource": "direct-input"
  }
}

Workflow fetched successfully

Pause Workflow

This API will pause the workflow, which means all scheduled executions will be canceled.

Get workflowId from the response of the above API.

post

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/workflows/{workflowId}/pause' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

200

{
  "success": true,
  "message": "text",
  "data": {
    "workflowId": "text",
    "isActive": true,
    "isInternalSchedule": true,
    "isScheduled": true,
    "isJobAddedOnQueue": true
  }
}

Workflow paused successfully

Get workflow nodes by workflow ID

This API will give you a list of all nodes in the workflow.

Get workflowId from the response of the above API.

get

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/workflows/{workflowId}/nodes' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "Workflow nodes fetched successfully",
  "total": 1,
  "data": [
    {
      "id": "The workflow node ID",
      "label": "The workflow node label",
      "nextNode": "The next node ID",
      "previousNode": "The previous node ID",
      "connectedAccountId": "The social account ID",
      "inputs": "The inputs for this node"
    }
  ]
}

Workflow nodes fetched successfully