Auditmark

Get sample report data for a template

POST
/templates/families/{family_id}/report-preview-payload

Structured JSON payload for the React web-report preview (sample data, no tenant media).

Mirrors report_preview but returns ReportPayload instead of rendered HTML. response_model validates the dict against the contract so the API can never silently drift from the model.

Authorization

OrgApiKey
AuthorizationBearer <token>

Organization API key. Send as Authorization: Bearer <key>. Create one in Admin > Settings > API keys.

In: header

Path Parameters

family_id*Family Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://api.auditmark.io/v1/templates/families/497f6eca-6276-4993-bfeb-53cbbbba6f08/report-preview-payload" \  -H "Content-Type: application/json" \  -d '{}'
{  "schema_version": 1,  "rtl": false,  "language": "en",  "strings": {},  "ai_summary": {},  "theme_tokens": {},  "page_size": "A4",  "assets": {},  "blocks": [],  "meta": {    "score_state": "off",    "show_subject": true,    "show_generated": false,    "show_completed": false,    "header_lines": []  },  "sections": [],  "findings": [],  "sign_offs": [],  "personnel": [],  "media_groups": [],  "intake_details": [],  "intake_groups": [],  "actions": [],  "image_size": "M",  "section_dividers": false,  "entry_titles_v2": false,  "media_unavailable": 0}
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}