Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
automation_rules
/
{id}
Get a automation rule details
curl --request GET \
  --url https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id} \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}")
  .header("api_access_token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/automation_rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "payload": {
    "id": 90,
    "account_id": 1,
    "name": "add-label-bug-if-message-contains-bug",
    "description": "add-label-bug-if-message-contains-bug",
    "event_name": "message_created",
    "conditions": [
      {
        "values": [
          "incoming"
        ],
        "attribute_key": "message_type",
        "query_operator": "and",
        "filter_operator": "equal_to"
      },
      {
        "values": [
          "bug"
        ],
        "attribute_key": "content",
        "filter_operator": "contains"
      }
    ],
    "actions": [
      {
        "action_name": "add_label",
        "action_params": [
          "bugs",
          "support-query"
        ]
      }
    ],
    "created_on": 1650555440,
    "active": true
  }
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
id
number
required

ID of the Automation Rule

​
account_id
integer
required

The numeric ID of the account

Response

Success

​
payload
object