Skip to main content
GET /api/v1/ returns the current API health object. It now includes platforms, where every supported platform has a current status and an internal note. Use this endpoint to decide whether parts of your app should stay active, be disabled, or show a message before a user starts a flow that may fail.
Do not display note directly to end users. Treat it as technical context for your product logic, support team, or internal dashboards.

Endpoint

Endpoint: GET /api/v1/

Platform Statuses

Poll this endpoint every 20 minutes from your backend or app shell. That is frequent enough to react to platform incidents without turning a health endpoint into unnecessary traffic. Avoid polling it before every single post, upload, or OAuth click. Cache the latest result and use it to guide your UI.

Example Usage

For example, if GOOGLE_BUSINESS.status is outage, disable Google Business posting and review import buttons. If INSTAGRAM.status is degraded, you may keep publishing enabled but show a short message like “Instagram is slower than usual right now.”
Use your own user-facing copy. The note field is useful context, but it may contain operational wording that is not polished for your customers.