---
title: "List Comment to DM rules"
method: GET
path: "/v1/comment-dm-rules"
---

# List Comment to DM rules

`GET /v1/comment-dm-rules`

## Request

- Base URL: `https://api.breakreach.com`
- URL: `https://api.breakreach.com/v1/comment-dm-rules`
- Auth: HTTP bearer

Comment to DM automations: when someone comments a keyword on a post of an Instagram account or a Facebook Page (or any post of it), Breakreach sends them a DM through a private reply (Instagram Direct, or Messenger from the Page), and optionally a public reply under the comment. Both networks allow one private reply per comment within 7 days of it, and Breakreach sends each person one DM per rule. Available on the Pro, Agency and Developer plans.

## Query parameters

- `accountId` string
- `mediaId` string
- `workspace` string

## Response `200`

OK

- object
  - `rules` CommentDmRule[], required
    - `id` string, required
    - `accountId` string, required
    - `platform` 'instagram' | 'facebook', required
    - `account` object
      - `displayName` string
      - `avatarUrl` string, nullable
    - `mediaId` string, nullable, required: The Instagram or Facebook post the rule watches; null = every post of the account
    - `media` object, nullable, required
      - `caption` string
      - `thumbnailUrl` string, nullable
      - `permalink` string, nullable
      - `timestamp` string, date-time, nullable
    - `keywords` string[], required: Empty = every comment triggers the rule
    - `match` 'contains' | 'exact', required
    - `dmText` string, required
    - `publicReplies` string[], required
    - `active` boolean, required
    - `stats` object, required
      - `triggered` integer
      - `sent` integer
      - `failed` integer
    - `lastTriggeredAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing, invalid or expired API key
- `402`: No active Breakreach subscription or trial
- `403`: Not a member of the requested workspace
- `404`: Workspace not found

---

[API](https://skmtc.dev/breakreach/apis/breakreach-api.md) · [All operations](https://skmtc.dev/breakreach/apis/breakreach-api/llms.txt) · [OpenAPI document](https://skmtc.dev/breakreach/apis/breakreach-api/revisions/290d285f8d73?raw)