DevelopersAPIReferencenotifications
List notifications
List a company's notifications with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.
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.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
Query Parameters
recipientUserId?string
types?string
Comma-separated notification types to return, e.g. "bankConnectionError,subscriptionChange". Omit to return all types.
eventType?string
For subscriptionChange notifications, return only this MRR event type: new, upgrade, downgrade, cancel, or reactivate.
createdAfter?string
Return notifications created on or after this date (YYYY-MM-DD).
createdBefore?string
Return notifications created on or before this date (YYYY-MM-DD).
limit?string
offset?string
Response Body
application/json
curl -X GET "https://example.com/companies/string/notifications"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "type": "string", "recipientUserId": "string", "readTime": "2019-08-24T14:15:22Z", "payload": { "property1": null, "property2": null }, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string" } ], "totalCount": 0, "earliestCreatedTime": "string"}