`compliance.reminders.preview`

Preview the grouped compliance reminder emails with recipients, subject, HTML and text. Mode upcoming (default) shows every open item within the reminder window, exactly what Send now would queue; mode scheduled shows only what the next daily digest would send. Nothing is sent.

GETPOST/api/v1/accounting/compliance.reminders.preview

Permissions

accounting:readaccounting:admin

Who can call it

admin

Retries

Safe to retry: it only reads

MCP

accounting_compliance_reminders_preview

Fields

modeenum
upcomingscheduled
Default "upcoming"

curl https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

GET/api/v1/accounting/compliance.reminders.preview

curl https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/compliance.reminders.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it