`documents.records.search`

Find a record whose details can go into a document: contractors, customers and vendors (party), merchants, teammates (member) and the company itself. Filter by type and search by name or email. Returns each record's type, id, name and a short description; read its details with documents.records.get.

GETPOST/api/v1/accounting/documents.records.search

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_documents_records_search

Fields

typeenum
contractorpartymerchantmembercompanyall
Default "all"
querystring
Text to search for.
at most 200 characters · Default ""
limitinteger
How many results to return at most.
1 to 25 · Default 10

curl https://app.getoatmilk.com/api/v1/accounting/documents.records.search \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.records.search", {
  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/documents.records.search",
    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/documents.records.search

curl https://app.getoatmilk.com/api/v1/accounting/documents.records.search \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.records.search", {
  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/documents.records.search",
    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