`compliancePortal.search`

Search the compliance portal in plain words: library guides, rules from official sources, decisions waiting for this member and topics. Word matching shortlists candidates and a fast classifier (Jev) ranks what the person means. Optional kinds (entry, rule, item, topic) narrows it, limit up to 20. Each hit has its kind, title, the passage that matched and how relevant the classifier judged it.

GETPOST/api/v1/accounting/compliancePortal.search

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_compliance_portal_search

Fields

querystringRequired
Text to search for.
2–500 characters
limitinteger
How many results to return at most.
1 to 20
kindsarray of enum values
entryruleitemtopic
at most 4 items

curl -G https://app.getoatmilk.com/api/v1/accounting/compliancePortal.search \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'query=office supplies'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/compliancePortal.search?query=office+supplies", {
  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/compliancePortal.search",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "query": "office supplies",
    },
    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/compliancePortal.search

curl -G https://app.getoatmilk.com/api/v1/accounting/compliancePortal.search \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'query=office supplies'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/compliancePortal.search?query=office+supplies", {
  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/compliancePortal.search",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "query": "office supplies",
    },
    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