Workflows

Get all workflows

GET/api/v1/public/workflows

Authorization

bearer

Query parameters

Header parameters

Response

200204401422500

Workflows fetched successfully

Body

application/json

success*boolean

message*string

Example: "Workflows fetched successfully"

total*number

data*array of WorkflowData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/workflows?start=0&limit=0', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

200

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

Get workflow by ID

Get workflowId from the response of the above API.

GET/api/v1/public/workflows/{workflowId}

Authorization

bearer

Path parameters

workflowId*string

Header parameters

Response

200204401404422500

Workflow fetched successfully

Body

application/json

success*boolean

message*string

Example: "Workflow fetched successfully"

data*WorkflowByIdData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/workflows/{workflowId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

200

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

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/api/v1/public/workflows/{workflowId}/nodes

Authorization

bearer

Path parameters

workflowId*string

Header parameters

Response

200204401404422500

Workflow nodes fetched successfully

Body

application/json

success*boolean

message*string

Example: "Workflow nodes fetched successfully"

total*number

data*array of WorkflowNodeData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/workflows/{workflowId}/nodes', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false,
  "message": "Workflow nodes fetched successfully",
  "total": 0,
  "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"
    }
  ]
}