`signing.envelopes.download`

Get a short-lived private download for an envelope document: the original upload, the signable PDF, or the completed PDF with its certificate of completion. Downloads are recorded in the audit trail.

GETPOST/api/v1/accounting/signing.envelopes.download

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

Not offered over MCP: Accountants' supporting originals grant isn't offered over MCP yet: phase 1 is read and comment only.

Fields

idstring (ID)Required
The record's ID.
documentenum
originalsignablecompleted
Default "completed"

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/signing.envelopes.download?id=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/signing.envelopes.download",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "id": "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/signing.envelopes.download

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

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/signing.envelopes.download?id=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/signing.envelopes.download",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "id": "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