`contractorOps.directory.list`

List every contractor with their roles, department, status, rate and pay cadence, payment profile completeness (masked), agreement on file, pending hours, next hours due date, last activity, their recent pay periods and live payouts with whether payouts are prepared for them automatically (pay, the same as contractorOps.profiles.get returns, for when they are paid next), and for anyone who has not joined the portal where their invitation stands (invite: state and label, such as not_invited, sent, delivered, bounced or expired; null once they have joined). Filter by query, status, department, or role.

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

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_directory_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
querystring
Text to search for.
at most 200 characters
statusenum
Only include records with this status.
onboardingactiveinactive
departmentstring
at most 120 characters
rolestring
A person's access level in the company.
at most 80 characters

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

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

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

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