List automation rules

GET/v1/automation/rules

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsAutomationRuleItem[] | nullrequired

Show properties

Array of AutomationRuleItem

actionsAutomationRuleAction[] | nullrequired

Show properties

Array of AutomationRuleAction

agent_idstring

fixed_agent_idstring

labelstring

label_idstring

strategystring

typestringrequired

created_atstringrequired

created_bystringrequired

enabledbooleanrequired

idstringrequired

namestringrequired

organization_idstringrequired

scopeAutomationRuleScoperequired

Show properties

channel_typestring

conversation_idstring

triggerAutomationRuleTriggerrequired

Show properties

eventstring

eventsstring[] | null

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/automation/rules"

const response = await fetch("/v1/automation/rules", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/automation/rules",
)

Response

{
  "items": [
    {
      "actions": [
        {
          "agent_id": "string",
          "fixed_agent_id": "string",
          "label": "string",
          "label_id": "string",
          "strategy": "string",
          "type": "string"
        }
      ],
      "created_at": "string",
      "created_by": "string",
      "enabled": true,
      "id": "string",
      "name": "string",
      "organization_id": "string",
      "scope": {
        "channel_type": "string",
        "conversation_id": "string"
      },
      "trigger": {
        "event": "string",
        "events": [
          "string"
        ]
      }
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}