---
title: "Get a automation rule details"
method: GET
path: "/v1/workspaces/{workspace_id}/automation_rules/{id}"
tags: ["Automation rules"]
---

# Get a automation rule details

`GET /v1/workspaces/{workspace_id}/automation_rules/{id}`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/automation_rules/{id}`
- Auth: API key in header `api_access_token`

Get the details of a automation rule in the account

## Path parameters

- `id` integer, required

## Response `200`

Success

- AutomationRule
  - `payload` union: Response payload that contains automation rule(s)
    - AutomationRuleItem[]: Array of automation rules (for listing endpoint)
      - `id` integer: The ID of the automation rule
      - `account_id` integer: Account Id
      - `name` string: The name of the rule
      - `description` string: Description to give more context about the rule
      - `event_name` 'conversation_created' | 'conversation_updated' | 'message_created': Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
      - `conditions` object[]: Array of conditions on which conversation/message filter would work
        - `values` string[]
        - `attribute_key` string
        - `query_operator` string
        - `filter_operator` string
      - `actions` object[]: Array of actions which we perform when condition matches
        - `action_name` string
        - `action_params` string[]
      - `created_on` integer: The timestamp when the rule was created
      - `active` boolean: Enable/disable automation rule
    - object: Single automation rule (for show/create/update endpoints)
      - `id` integer: The ID of the automation rule
      - `account_id` integer: Account Id
      - `name` string: The name of the rule
      - `description` string: Description to give more context about the rule
      - `event_name` 'conversation_created' | 'conversation_updated' | 'message_created': Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
      - `conditions` object[]: Array of conditions on which conversation/message filter would work
        - `values` string[]
        - `attribute_key` string
        - `query_operator` string
        - `filter_operator` string
      - `actions` object[]: Array of actions which we perform when condition matches
        - `action_name` string
        - `action_params` string[]
      - `created_on` integer: The timestamp when the rule was created
      - `active` boolean: Enable/disable automation rule

## Other responses

- `401`: Unauthorized
- `404`: The given rule ID does not exist in the account

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)