---
title: "Get an inbox automation rule"
method: GET
path: "/v1/workspaces/{workspaceId}/inbox/automation/rules/{ruleId}"
tags: ["Inbox automation"]
---

# Get an inbox automation rule

`GET /v1/workspaces/{workspaceId}/inbox/automation/rules/{ruleId}`

## Request

- Base URL: `https://api.maevesocial.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maevesocial.com/v1/workspaces/{workspaceId}/inbox/automation/rules/{ruleId}`
- Auth: HTTP bearer

## Path parameters

- `ruleId` string, required
- `workspaceId` string, uuid, required

## Response `200`

Inbox automation rule

- object
  - `data` PublicInboxAutomationRuleResultDto, required
    - `rule` PublicInboxAutomationRuleDto, required
      - `id` string, uuid, required
      - `integrationId` string, uuid, required
      - `name` string, required
      - `trigger` 'comment_keyword' | 'dm_keyword' | 'dm_welcome', required
      - `matchMode` 'any' | 'contains' | 'exact', required
      - `keywords` string[], required
      - `postScope` 'all' | 'specific', required
      - `postIds` string[], required
      - `publicReplyBody` string, nullable, required
      - `privateReplyBody` string, nullable, required
      - `dmReplyBody` string, nullable, required
      - `applyTagIds` string[], required
      - `assignToUserId` string, uuid, nullable, required
      - `disclosureEnabled` boolean, required
      - `cooldownHours` number, required: Per-participant cooldown in hours (0-168).
      - `dailyCap` number, required: Maximum executions per day (1-1000).
      - `enabled` boolean, required
      - `pausedAt` string, nullable, required: Set when the rule was auto-paused after repeated failures.
      - `pausedReason` string, nullable, required
      - `consecutiveFailures` number, required
      - `createdByUserId` string, uuid, nullable, required
      - `createdAt` string, nullable, required
      - `updatedAt` string, nullable, required
      - `executionCount` number, required
  - `meta` unknown, required

---

[API](https://skmtc.dev/maevesocial/apis/maeve-social-api.md) · [All operations](https://skmtc.dev/maevesocial/apis/maeve-social-api/llms.txt) · [OpenAPI document](https://skmtc.dev/maevesocial/apis/maeve-social-api/revisions/1b00fd7e4b15?raw)