API overview
The Updatify API lets you read your published product updates programmatically — for example to render release notes inside your own app, website, or mobile client.
Base URL
Section titled “Base URL”All API requests are made over HTTPS to your Updatify host:
https://updatify.ioVersioning
Section titled “Versioning”Stable, authenticated endpoints live under the /api/v1 prefix. The version is
part of the path so future breaking changes can ship under a new prefix without
affecting existing integrations.
https://updatify.io/api/v1A small number of unversioned endpoints exist under /api for the embeddable
widget (see Track update views).
Content type
Section titled “Content type”The API speaks JSON. Successful responses return application/json, and request
bodies (where applicable) should be sent as JSON.
Authentication
Section titled “Authentication”Authenticated endpoints require a bearer token in the Authorization header.
See Authentication for how to create and use one.
OpenAPI spec
Section titled “OpenAPI spec”The full machine-readable OpenAPI specification is served at:
GET https://updatify.io/api/openapiYou can feed that URL into tools like Postman, Insomnia, or an SDK generator.
Endpoints at a glance
Section titled “Endpoints at a glance”| Method | Path | Auth | Description |
|---|---|---|---|
GET | /api/v1/projects | Bearer | List your projects |
GET | /api/v1/projects/{id}/updates | Bearer | List published updates for a project |
POST | /api/projects/{project_id}/updates/{update_id}/track | None | Record a view of an update |
GET | /api/openapi | None | The OpenAPI spec document |