`contractorOps.agreements.contractorDraft`

Prefill for filing a signed agreement or NDA that has no contractor (envelopeId, or intakeItemId of the filed upload): the other party's name, email addresses, role and the job role and level it matches, rate, start and end dates and where they live, as the document states them with the words each came from, plus existing contractors it may be (any address Oatmilk knows for them, then the same name, then a close name) with which of the document's addresses each uses and whether the document is newer than their terms. Pass the name and email being added (name, email) to look those up too. Nothing is saved.

GETPOST/api/v1/accounting/contractorOps.agreements.contractorDraft

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_contractor_ops_agreements_contractor_draft

Fields

envelopeIdstring (ID)
The ID of a document sent for signature, from signing.envelopes.list.
intakeItemIdstring (ID)
The ID of the related record.
namestring
A display name.
at most 300 characters
emailstring (email)
An email address.
at most 320 characters

curl -G https://app.getoatmilk.com/api/v1/accounting/contractorOps.agreements.contractorDraft \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'envelopeId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.agreements.contractorDraft?envelopeId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", {
  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.agreements.contractorDraft",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "envelopeId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    },
    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.agreements.contractorDraft

curl -G https://app.getoatmilk.com/api/v1/accounting/contractorOps.agreements.contractorDraft \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'envelopeId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.agreements.contractorDraft?envelopeId=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", {
  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.agreements.contractorDraft",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "envelopeId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    },
    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