`accountants.invitations.preview`

Preview the invitation email (subject, HTML and plain text) for an access level, end date, name and message before sending it. Sends nothing and contains no private link.

GETPOST/api/v1/accounting/accountants.invitations.preview

Permissions

accounting:readaccounting:admin

Who can call it

admin

Retries

Safe to retry: it only reads

MCP

accounting_accountants_invitations_preview

Fields

emailstring
An email address.
at most 320 characters
namestring
A display name.
at most 200 characters
firmstring
at most 200 characters
messagestring
at most 2000 characters
presetenum
readcommentprepare
Default "read"
accessExpiresOnstring or null
Default null

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/accountants.invitations.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/accountants.invitations.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/accountants.invitations.preview

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/accountants.invitations.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/accountants.invitations.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