Website

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
Authorizations
Query parameters
startnumberOptional

The page No

Example: 0
limitnumber · min: 1 · max: 50Optional

The Page Size

Example: 10
platformIdstringRequired

Platform ID

Example: 622f03eb770f6bba0b8facaa
Header parameters
X-TexAu-ContextstringRequired

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

Responses
200
Automations fetch successful
application/json
get
GET /api/v1/public/automations?platformId=622f03eb770f6bba0b8facaa HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Automations fetch successful",
  "total": 1,
  "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
Authorizations
Path parameters
automationIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

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

Responses
200
Automation fetched successfully
application/json
get
GET /api/v1/public/automations/{automationId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "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"
      }
    ]
  }
}
PreviousPlatformsNextWorkflows

Last updated