Skip to main content
GET
/
api
/
public
/
v1
/
automation
List automation rules
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/automation \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "isActive": true,
      "priority": 123,
      "companyIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "triggerType": "<string>",
      "entityType": "<string>",
      "actionsCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
search
string

Search in name and description

Maximum string length: 255
​
isActive
boolean | null

Filter by active status

​
triggerType
enum<string>

Filter by trigger type

Available options:
date_threshold,
scheduled,
field_change,
absence
​
entityType
enum<string>

Filter by entity type

Available options:
device,
company,
compliance,
planner,
user,
goal,
training,
ticket,
meeting
​
sortColumn
enum<string>
default:created_at

Field to sort by

Available options:
name,
priority,
is_active,
trigger_type,
entity_type,
created_at,
updated_at
​
sortDesc
boolean | null
default:true

Sort descending

Response

List of automation rules

​
data
object[]
required

Array of automation rules

​
pagination
object
required