API Reference

Returns a paginated list of your firm's clients.

curl "https://streamlinereports.com/api/v1/clients?status=OVERDUE" \
  -H "Authorization: Bearer sr_live_..."

Updates a client. Only fields included in the body are changed.

curl -X PATCH "https://streamlinereports.com/api/v1/clients/clm_abc123" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "defaultTemplateId": "tpl_xyz", "reportDueDay": 10 }'

Fires a client.updated webhook event on success.

Returns a paginated list of reports.

curl "https://streamlinereports.com/api/v1/reports?clientId=clm_abc123&status=SENT" \
  -H "Authorization: Bearer sr_live_..."

Creates a new report. One report per client + period — returns 409 CONFLICT if a duplicate exists.

curl -X POST "https://streamlinereports.com/api/v1/reports" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "clientId": "clm_abc123", "period": "2026-03", "templateId": "tpl_xyz" }'

Returns a single report including a summary of its blocks. Raw financial data is not exposed.

Deletes a report. Sent reports (status: SENT) cannot be deleted — returns 403 FORBIDDEN.

Triggers PDF generation. Uses a fast-path cache — if the report content is unchanged, returns COMPLETE immediately. Otherwise enqueues generation and returns 202 QUEUED.

// Immediate (cached)
{ "data": { "status": "COMPLETE", "downloadUrl": "https://..." } }

// Queued
{ "data": { "status": "QUEUED", "jobId": "job_..." } }

Poll GET /reports/:id until status is COMPLETE, then fetch the PDF URL. A report.generated webhook fires when done.

Rate limited to 10 generation jobs per minute per firm (shared with dashboard usage).

Sends a report to an email address. Report must have a generated PDF (status: COMPLETE).

Fires a report.sent webhook event on success.

Returns a signed download URL for the report PDF. URL is valid for 1 hour.

{ "data": { "url": "https://...", "filename": "Acme_2026-03.pdf", "expiresIn": 3600 } }

Lists all report templates — system templates and firm-created templates.

Creates a blank report template. Add blocks afterwards with POST /report-templates/:id/blocks.

curl -X POST "https://streamlinereports.com/api/v1/report-templates" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "templateName": "Monthly — Standard", "defaultPeriodType": "monthly" }'

# Then add blocks one at a time:
curl -X POST "https://streamlinereports.com/api/v1/report-templates/tpl_xyz/blocks" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "PL" }'

Valid block types include COVER_PAGE, PL, BALANCE_SHEET, CASH_FLOW, AR_AGING — the full list is in the ReportBlock schema of the OpenAPI spec.

Returns a single template with its full block list.

Adds a block to a template. System templates cannot be modified.

Deletes a firm-created template. System templates cannot be deleted.

Lists all email templates for the firm.

Creates a new email template.

curl -X POST "https://streamlinereports.com/api/v1/email-templates" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly close",
    "subject": "{{client_name}} — {{period}} Financial Report",
    "body": "Hi {{client_name}},\n\nAttached is your {{period}} report.\n\n{{firm_name}}"
  }'

Returns a single email template.

Updates an email template. System templates cannot be modified.

Deletes a firm-created email template. System templates cannot be deleted.

Lists all registered webhook endpoints for the firm. Endpoints auto-paused after repeated delivery failures show pausedAt and disabledReason.

Registers a new endpoint. URL must be https:// and not resolve to a private IP address. Returns the signing secret — shown only once.

curl -X POST "https://streamlinereports.com/api/v1/webhooks" \
  -H "Authorization: Bearer sr_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhooks/streamline",
    "events": ["report.sent", "report.generated"],
    "description": "n8n report pipeline"
  }'

Deactivates a webhook endpoint. Delivery history is retained and the endpoint still appears in the list with isActive: false.

Returns the last 100 delivery attempts for an endpoint.

Returns basic information about your firm. Does not include billing details or OAuth tokens.

{
  "data": {
    "id": "clm_...",
    "name": "Your Firm",
    "plan": "TEAM",
    "seats": { "included": 3, "purchased": 1, "max": 10 }
  }
}