`contractorOps.periods.list`

List contractor pay periods with period dates, hours due date, pay date, status (open, submitted, approved, paid, skipped), and submitted and approved minutes.

GETPOST/api/v1/accounting/contractorOps.periods.list

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_periods_list

Fields

limitinteger
How many results to return at most.
1 to 100 · Default 30
offsetinteger
How many results to skip, for the next page of a list.
0 to 100000 · Default 0
contractorIdstring (ID)
The ID of a contractor, from contractors.list.
statusenum
Only include records with this status.
opensubmittedapprovedpaidskipped
fromstring (date)
The first date to include, as YYYY-MM-DD.
tostring (date)
The last date to include, as YYYY-MM-DD.

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

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

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

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