`engagements.list`

List agreement versions for an existing project. One engagement can involve multiple independent legal businesses; trading names remain separate. Includes draft, proposed, review and recorded executed states. No signed or paid status is inferred.

GETPOST/api/v1/accounting/engagements.list

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_engagements_list

Fields

projectIdstring (ID)Required
The ID of the related record.
limitinteger
How many results to return at most.
1 to 100 · Default 25
offsetinteger
How many results to skip, for the next page of a list.
0 to 9007199254740991 · Default 0

curl -G https://app.getoatmilk.com/api/v1/accounting/engagements.list \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'projectId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/engagements.list?projectId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a", {
  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/engagements.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "projectId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    },
    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/engagements.list

curl -G https://app.getoatmilk.com/api/v1/accounting/engagements.list \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'projectId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/engagements.list?projectId=4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a", {
  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/engagements.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "projectId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    },
    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