SaaSFlow
DevelopersAPIReferencereports

Retrieve report

Retrieve one report, including its rendered document once generation has finished. Poll this after starting a report: until it is ready the document is absent and only the status tells you where it is. Returns 404 if the report does not exist or belongs to another company.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
GET
/companies/{companyId}/reports/{id}

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length
id*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/reports/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "definitionId": "string",  "reportMonth": "string",  "status": "generating",  "runId": "78c33d18-170c-44d3-a227-b3194f134f73",  "title": "string",  "summary": "string",  "error": "string",  "document": {    "schemaVersion": 1,    "title": "string",    "period": {      "month": "string"    },    "facts": {      "mrrBasis": "cmrr",      "timeZone": "string",      "endMrr": 0,      "priorEndMrr": 0,      "mrrGrowthPct": 0,      "endCustomerCount": 0,      "newMrr": 0,      "churnedMrr": 0    },    "summary": "string",    "html": "string"  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Create report

Start generating a performance report for one month. This returns as soon as the agent run is queued, giving back a `reportId` to poll and a `runId` for following the agent, so the document is not ready yet. Because an AI agent reads company data to write it, a company that has not consented to the agent's AI provider gets a 403 carrying `code: "aiConsentRequired"` and the `providerKey` to request consent for. Only one report generates per company at a time (409), and there is a per-company rate limit (429, with `retryAt` when it can be retried).

Update report

Rename a report. Only the display title changes; the document and its numbers are untouched. A report that is still generating cannot be renamed and returns 409.