Skip to main content
GET
/
api
/
public
/
v1
/
automation
/
{id}
Get automation rule
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/automation/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "isActive": true,
    "priority": 123,
    "scopeType": "tenant",
    "companyIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "triggerType": "<string>",
    "entityType": "<string>",
    "triggerConfig": {},
    "conditions": [
      {
        "id": "<string>",
        "logic": "AND",
        "conditions": [
          {
            "id": "<string>",
            "field": "<string>",
            "operator": "<string>",
            "value": "<unknown>"
          }
        ],
        "groups": [
          "<unknown>"
        ]
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "actionType": "<string>",
        "config": {},
        "order": 123,
        "requiresApproval": true
      }
    ],
    "aggregationConfig": {
      "enabled": true,
      "groupBy": "<string>",
      "groupField": "<string>",
      "minBatchSize": 123,
      "maxWaitHours": 123,
      "combinedActionConfig": {
        "titleTemplate": "<string>",
        "descriptionTemplate": "<string>"
      }
    },
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "updatedBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "version": 123,
    "companies": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Rule ID

Response

Rule details with full configuration

data
object
required