Owner Reports
- GET
/rest/v1.0/companies/{company_id}/owner_reportsList portfolio owner reports - POST
/rest/v1.0/companies/{company_id}/owner_reportsCreate a portfolio owner report - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}Show an owner report - PATCH
/rest/v1.0/companies/{company_id}/owner_reports/{id}Update an owner report - DELETE
/rest/v1.0/companies/{company_id}/owner_reports/{id}Delete an owner report - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/pdfDownload a draft PDF - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/previewPreview the live report - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/share_linksList share links - POST
/rest/v1.0/companies/{company_id}/owner_reports/{id}/share_linksCreate an owner share link - DELETE
/rest/v1.0/companies/{company_id}/owner_reports/{id}/share_links/{link_id}Revoke a share link - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/share_links/{link_id}/viewsShare link access log - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/versionsList versions - POST
/rest/v1.0/companies/{company_id}/owner_reports/{id}/versionsPublish a version - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/versions/{version_id}Show a frozen version - GET
/rest/v1.0/companies/{company_id}/owner_reports/{id}/versions/{version_id}/pdfDownload a frozen version's PDF - GET
/rest/v1.0/companies/{company_id}/owner_reports/ownersList owners for portfolio reports - GET
/rest/v1.0/projects/{project_id}/owner_reportsList owner reports - POST
/rest/v1.0/projects/{project_id}/owner_reportsCreate an owner report - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}Show an owner report - PATCH
/rest/v1.0/projects/{project_id}/owner_reports/{id}Update an owner report - DELETE
/rest/v1.0/projects/{project_id}/owner_reports/{id}Delete an owner report - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/pdfDownload a draft PDF - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/previewPreview the live report - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/share_linksList share links - POST
/rest/v1.0/projects/{project_id}/owner_reports/{id}/share_linksCreate an owner share link - DELETE
/rest/v1.0/projects/{project_id}/owner_reports/{id}/share_links/{link_id}Revoke a share link - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/share_links/{link_id}/viewsShare link access log - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/versionsList versions - POST
/rest/v1.0/projects/{project_id}/owner_reports/{id}/versionsPublish a version - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/versions/{version_id}Show a frozen version - GET
/rest/v1.0/projects/{project_id}/owner_reports/{id}/versions/{version_id}/pdfDownload a frozen version's PDF
/rest/v1.0/companies/{company_id}/owner_reportsList portfolio owner reports
Portfolio reports belong to their creator and company administrators; each project inside is read with your access in that project.
Parameters
- company_idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reportsCreate a portfolio owner report
Default period: the previous calendar month. Token scope: owner_reports:write.
Parameters
- company_idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- owner_reportobjectrequiredGive owner_vendor_id, project_ids, or both (projects filtered to the owner).
- owner_report.titlestring
- owner_report.owner_vendor_idinteger
- owner_report.project_idsinteger[]
- owner_report.period_startstring (date)
- owner_report.period_endstring (date)
Response · 201 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).422Validation failed.
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/owner_reports" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"owner_report": {}
}'/rest/v1.0/companies/{company_id}/owner_reports/{id}Show an owner report
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/{id}Update an owner report
Edit the narrative, section commentary, risks, sections, period and photo selection. Published versions are never changed.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- owner_reportobjectrequired
- owner_report.titlestring
- owner_report.period_startstring (date)
- owner_report.period_endstring (date)
- owner_report.sectionsstring[]One of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- owner_report.contentobject
- owner_report.content.executive_summarystring
- owner_report.content.section_notesobjectCommentary per section key.
- owner_report.content.risksobject[]
- owner_report.content.risks[].titlestringrequired
- owner_report.content.risks[].impactstringrequiredOne of: low, medium, high.
- owner_report.content.risks[].statusstringrequiredOne of: open, monitoring, closed.
- owner_report.content.risks[].ownerstringrequired
- owner_report.content.risks[].mitigationstringrequired
- owner_report.content.lookahead_weeksintegerOne of: 2, 3, 6.
- owner_report.photo_idsinteger[]
Response · 200 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).422Validation failed.
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"owner_report": {}
}'/rest/v1.0/companies/{company_id}/owner_reports/{id}Delete an owner report
Soft-deletes the report and revokes its share links. Versions are kept.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 204
No response body.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X DELETE "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/companies/{company_id}/owner_reports/{id}/pdfDownload a draft PDF
Renders the live report as a branded PDF without publishing.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
Response · 200 · string (binary)
No documented fields.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/pdf" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/{id}/previewPreview the live report
Assembles the report now from live project data with your access. Nothing is stored.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- documentobjectThe fully formatted report: every value is a display string. A denied source makes its section status unavailable (never zero).
- document.vintegerrequired
- document.templatestringrequired
- document.titlestringrequired
- document.companyobjectrequired
- document.projectobject | null
- document.projectsobject[]
- document.ownerstring | null
- document.periodobjectrequired
- document.preparedBystring
- document.generatedAtstring (date-time)
- document.sectionsobject[]required
- sourcesstring[]
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/preview" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/{id}/versionsList versions
Published versions and scheduled deliveries, newest first.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/versions" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/{id}/versionsPublish a version
Assembles the report with your access and freezes it (JSON, branded PDF and photo bytes, PDF SHA-256). Versions are immutable.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 201 · object
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/versions" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/companies/{company_id}/owner_reports/{id}/versions/{version_id}Show a frozen version
Requires view on Owner Reports and on every source tool the version contains.
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
- version_idintegerpathrequired
Response · 200 · object
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
- documentobjectThe fully formatted report: every value is a display string. A denied source makes its section status unavailable (never zero).
- document.vintegerrequired
- document.templatestringrequired
- document.titlestringrequired
- document.companyobjectrequired
- document.projectobject | null
- document.projectsobject[]
- document.ownerstring | null
- document.periodobjectrequired
- document.preparedBystring
- document.generatedAtstring (date-time)
- document.sectionsobject[]required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/versions/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/{id}/versions/{version_id}/pdfDownload a frozen version's PDF
Served only when its SHA-256 still matches (409 otherwise).
Parameters
- company_idintegerpathrequired
- idintegerpathrequired
- version_idintegerpathrequired
Response · 200 · string (binary)
No documented fields.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).409Integrity check failed.
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/1/versions/1/pdf" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/companies/{company_id}/owner_reports/ownersList owners for portfolio reports
Owners (vendors on prime contracts) with the projects where you can view Owner Reports.
Parameters
- company_idintegerpathrequired
Response · 200 · object[]
- idinteger
- namestring
- projectsobject[]
- projects[].idinteger
- projects[].namestring
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/owner_reports/owners" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reportsList owner reports
Owner Reports tool permission (view to read; create, edit or delete to change). Data sections are assembled with your access in each source tool.
Parameters
- project_idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reportsCreate an owner report
Default period: the previous calendar month. Templates: monthly_aia (AIA-style monthly report), gmp_cost (cost-plus backup summary), executive (one-pager).
Parameters
- project_idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- owner_reportobjectrequired
- owner_report.templatestringrequiredOne of: monthly_aia, gmp_cost, executive.
- owner_report.titlestring
- owner_report.period_startstring (date)
- owner_report.period_endstring (date)
- owner_report.sectionsstring[]One of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
Response · 201 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).422Validation failed.
Example request
curl -X POST "https://app.os.construction/rest/v1.0/projects/1/owner_reports" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"owner_report": {
"template": "monthly_aia"
}
}'/rest/v1.0/projects/{project_id}/owner_reports/{id}Show an owner report
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reports/{id}Update an owner report
Edit the narrative, section commentary, risks, sections, period and photo selection. Published versions are never changed.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Request body
- owner_reportobjectrequired
- owner_report.titlestring
- owner_report.period_startstring (date)
- owner_report.period_endstring (date)
- owner_report.sectionsstring[]One of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- owner_report.contentobject
- owner_report.content.executive_summarystring
- owner_report.content.section_notesobjectCommentary per section key.
- owner_report.content.risksobject[]
- owner_report.content.risks[].titlestringrequired
- owner_report.content.risks[].impactstringrequiredOne of: low, medium, high.
- owner_report.content.risks[].statusstringrequiredOne of: open, monitoring, closed.
- owner_report.content.risks[].ownerstringrequired
- owner_report.content.risks[].mitigationstringrequired
- owner_report.content.lookahead_weeksintegerOne of: 2, 3, 6.
- owner_report.photo_idsinteger[]
Response · 200 · object
- idintegerrequired
- scopestringrequiredOne of: project, portfolio.
- project_idinteger | null
- project_idsinteger[]Portfolio reports: the projects included.
- owner_vendor_idinteger | null
- templatestringrequiredOne of: monthly_aia, gmp_cost, executive, portfolio.
- template_namestring
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sectionsstring[]requiredOne of: executive_summary, budget_gmp, contingency_allowances, billing, change_orders, schedule, lookahead, rfis_submittals, safety, quality, photos, risks, compliance.
- contentobjectrequired
- content.executive_summarystring
- content.section_notesobjectCommentary per section key.
- content.risksobject[]
- content.lookahead_weeksintegerOne of: 2, 3, 6.
- photo_idsinteger[]required
- created_by_idinteger
- created_atstring (date-time)required
- updated_atstring (date-time)required
- latest_versionobject | null
- latest_version.idinteger
- latest_version.versioninteger
- latest_version.published_atstring (date-time)
- active_share_linksinteger | null
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).422Validation failed.
Example request
curl -X PATCH "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
-d '{
"owner_report": {}
}'/rest/v1.0/projects/{project_id}/owner_reports/{id}Delete an owner report
Soft-deletes the report and revokes its share links. Versions are kept.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 204
No response body.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X DELETE "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/projects/{project_id}/owner_reports/{id}/pdfDownload a draft PDF
Renders the live report as a branded PDF without publishing.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · string (binary)
No documented fields.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/pdf" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reports/{id}/previewPreview the live report
Assembles the report now from live project data with your access. Nothing is stored.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object
- documentobjectThe fully formatted report: every value is a display string. A denied source makes its section status unavailable (never zero).
- document.vintegerrequired
- document.templatestringrequired
- document.titlestringrequired
- document.companyobjectrequired
- document.projectobject | null
- document.projectsobject[]
- document.ownerstring | null
- document.periodobjectrequired
- document.preparedBystring
- document.generatedAtstring (date-time)
- document.sectionsobject[]required
- sourcesstring[]
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/preview" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reports/{id}/versionsList versions
Published versions and scheduled deliveries, newest first.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
Response · 200 · object[]
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/versions" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reports/{id}/versionsPublish a version
Assembles the report with your access and freezes it (JSON, branded PDF and photo bytes, PDF SHA-256). Versions are immutable.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
- Idempotency-KeystringheaderOptional. A unique key (1-255 visible ASCII characters, e.g. a UUID) that makes a retry safe. The first request with a key runs; a 2xx response is stored for 24 hours and a retry with the same key, token and path gets that response again with `Idempotent-Replayed: true`. The same key with a different request returns 422; while the first request is still running, 409. A non-2xx response releases the key.
Response · 201 · object
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X POST "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/versions" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN" \
-H "Idempotency-Key: $(uuidgen)"/rest/v1.0/projects/{project_id}/owner_reports/{id}/versions/{version_id}Show a frozen version
Requires view on Owner Reports and on every source tool the version contains.
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
- version_idintegerpathrequired
Response · 200 · object
- idintegerrequired
- report_idintegerrequired
- versionintegerrequired
- kindstringrequiredOne of: published, scheduled.
- titlestringrequired
- period_startstring (date)required
- period_endstring (date)required
- sourcesstring[]requiredTool slugs whose data the frozen version contains.
- sha256stringrequiredSHA-256 of the frozen PDF.
- pdf_bytesintegerrequired
- photo_countinteger
- published_byobject
- published_by.idinteger
- published_by.namestring | null
- rendered_forobject | null
- created_atstring (date-time)required
- documentobjectThe fully formatted report: every value is a display string. A denied source makes its section status unavailable (never zero).
- document.vintegerrequired
- document.templatestringrequired
- document.titlestringrequired
- document.companyobjectrequired
- document.projectobject | null
- document.projectsobject[]
- document.ownerstring | null
- document.periodobjectrequired
- document.preparedBystring
- document.generatedAtstring (date-time)
- document.sectionsobject[]required
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/versions/1" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"/rest/v1.0/projects/{project_id}/owner_reports/{id}/versions/{version_id}/pdfDownload a frozen version's PDF
Served only when its SHA-256 still matches (409 otherwise).
Parameters
- project_idintegerpathrequired
- idintegerpathrequired
- version_idintegerpathrequired
Response · 200 · string (binary)
No documented fields.
Errors
401Missing or invalid credentials.403No permission, tool disabled, or token lacks the scope.404Not found (or not visible to you).409Integrity check failed.
Example request
curl -X GET "https://app.os.construction/rest/v1.0/projects/1/owner_reports/1/versions/1/pdf" \
-H "Authorization: Bearer $OS_ACCESS_TOKEN"