Salfio
API

Overview

Salfio's public API at api.salfio.com/v1 — base URL, versioning, and what you can do with it.

Salfio exposes a public REST-style API at https://api.salfio.com/v1 for partners, internal services, and the Salfio MCP server. It is the same surface every programmatic integration with Salfio uses.

Base URL

https://api.salfio.com/v1

All endpoints are served over HTTPS with a valid certificate. HTTP is refused.

Versioning

The version is part of the path. /v1 is the current and only production version. Breaking changes land on /v2. Additive changes (new endpoints, new optional fields) happen within /v1 without warning — treat responses with the additionalProperties convention in mind: ignore fields you don't recognize.

What ships today

The foundations ticket shipped:

  • Bearer authentication with sk_live_… keys (Authentication)
  • Response envelope {data, meta} (Conventions)
  • Structured error format {error: {code, message, details}}
  • Cursor pagination (limit, cursor)
  • Redis-backed rate limiting with X-RateLimit-* headers (Rate limits)
  • GET /v1/health as the authenticated smoke test

Resource endpoints (clients, activities, users, organization, default dashboards) are landing in follow-up tickets — they will appear in the generated Reference as they ship.

Support

  • Issues or spec questions: open a ticket in the Salfio Linear project
  • API downtime or degraded performance: see the status page

On this page