`signing.envelopes.list`

List signature envelopes with their status, linked record, recipients' progress, and key dates. Filter by status (including open and attention), templateKey, subjectType and subjectId (for example contractor), or a title/recipient search. Each envelope says whether it is waiting for your own signature (awaitingMe) and, when it is, gives signUrl: the page where you sign it yourself. Pass awaitingMe: true to list only those. Signing only happens there; agents can't sign for you. An envelope made from a job gives the job's title and version and its pay as the agreement states it (pay, rateBasis job or one_off). counts: true also returns how many envelopes each status filter holds.

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

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

statusenum
Only include records with this status.
draftsentin_progresschanges_requestedcompletingcompleteddeclinedvoidedexpiredopenattention
templateKeystring
Matches ^[a-z][a-z0-9-]{1,60}$
subjectTypeenum
The kind of record this is about, such as entry, invoice or mail.
contractorpartyinvoice
subjectIdstring
The ID of the record this is about.
1–200 characters
querystring
Text to search for.
at most 200 characters
awaitingMeboolean
countsboolean
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

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

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

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

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