`sponsorships.list`

List sponsorships in the current company by projectId, customer partyId or existing income entryId, with exact count and pagination. Customer/legal sponsor and individual payer stay separate; proposed context is not confirmed treatment.

GETPOST/api/v1/accounting/sponsorships.list

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_sponsorships_list

Fields

projectIdstring (ID)
The ID of the related record.
partyIdstring (ID)
The ID of a customer or vendor account, from parties.list.
entryIdstring (ID)
The ID of an accounting entry, from entries.list or attention.mine.
includeArchivedboolean
Also include archived records.
Default false
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 100000 · Default 0

curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.list \
  -H "Authorization: Bearer $OATMILK_API_KEY"

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

curl https://app.getoatmilk.com/api/v1/accounting/sponsorships.list \
  -H "Authorization: Bearer $OATMILK_API_KEY"

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