Private preview of the new site. Not live.

reports.run

Run a saved report now: its date range is worked out on the shop's calendar (or around as_of), and the report operation runs with the caller's own permissions. Returns the exact input used and the operation's result.

WhoAgents can call this
RESTPOST /v1/reports/saved/run
MCP toolreports_run
Writesno
AreaCosts, expenses and reports

When to use it

Run a saved report now: its date range is worked out on the shop's calendar (or around as_of), and the report operation runs with the caller's own permissions. Returns the exact input used and the operation's result.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
report_idstring (uuid)yes
as_ofstringno

Example

POST https://doingwork.work/v1/reports/saved/run
content-type: application/json
Idempotency-Key: 3f1c...

{
  "report_id": "00000000-0000-4000-8000-000000000000"
}

Output

FieldTypeAlways there
reportobjectyes
report.report_idstring (uuid)yes
report.namestringyes
report.op_idstringyes
report.paramsobjectyes
report.date_range['string', 'null']yes
report.created_bystring (uuid)yes
report.created_atstring (date-time)yes
report.updated_atstring (date-time)yes
inputobjectyes
resultobjectyes
{
  "report": {
    "report_id": "00000000-0000-4000-8000-000000000000",
    "name": "Ruiz Plumbing",
    "op_id": "00000000-0000-4000-8000-000000000000",
    "params": {},
    "date_range": "...",
    "created_by": "00000000-0000-4000-8000-000000000000",
    "created_at": "...",
    "updated_at": "..."
  },
  "input": {},
  "result": {}
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.