Automations

Get all Automations

This API gives you a list of all automations for a specific platform.

Use this to get the platform ID.

GET/api/v1/public/automations

Authorization

bearer

Query parameters

Header parameters

Response

200204401422500

Automations fetch successful

Body

application/json

success*boolean

message*string

Example: "Automations fetch successful"

total*number

data*array of AutomationData (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "message": "Automations fetch successful",
  "total": 0,
  "data": [
    {
      "id": "Automation ID",
      "name": "Automation name",
      "label": "Automation label",
      "platformId": "Platform ID"
    }
  ]
}

Get Automation By ID

This API will give you a list of inputs and output of specific automation.

Use automationID from response of the above API

GET/api/v1/public/automations/{automationId}

Authorization

bearer

Path parameters

automationId*string

Header parameters

Response

200204401404422500

Automation fetched successfully

Body

application/json

success*boolean

message*string

Example: "Automation fetched successfully"

data*AutomationByIdData (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "message": "Automation fetched successfully",
  "data": {
    "id": "The Automation ID",
    "name": "The Automation name",
    "description": "The Automation description",
    "shortName": "The Automation short name",
    "category": "The Automation category",
    "platformId": "The Platform ID",
    "inputs": [
      {
        "name": "The input name, e.g., liProfileUrl",
        "label": "The input label, e.g., Profile URL",
        "description": "The input description, e.g., Linkedin Profile URL",
        "type": "The input type, e.g., text",
        "isRequired": true,
        "choices": []
      }
    ],
    "outputs": [
      {
        "name": "The output name, e.g., liProfileUrl",
        "label": "The output label, e.g., Profile URL",
        "description": "The output description, e.g., Linkedin Profile URL",
        "type": "The output type, e.g., text"
      }
    ]
  }
}