API Overview

The Cloudflow public API lets integration builders work with selected organization resources from external systems.

Base URL

https://app.cloudflowtechnology.com/api

Initial Public Surface

The first documented public API includes:

Services
Customers
Statuses
Service types
Service contacts
Market availability

Internal mobile helpers, cron processors, webhook receivers, provider-specific integration routes, and legacy /v1 Auth0 routes are not part of this public contract.

OpenAPI Specification

The interactive endpoint pages are generated from reference/cloudflow-public-api.yaml. The GitHub workflow uploads that file to the ReadMe v1.0 branch with the API definition slug cloudflow-public-api.yaml, which is the same value used by each endpoint page's api.file frontmatter.

Response Envelopes

List endpoints use:

{
  "data": [],
  "meta": {
    "total": 0,
    "page": 1,
    "limit": 50,
    "totalPages": 0
  }
}

Single-resource endpoints use:

{
  "data": {}
}

Create endpoints may return a named resource such as { "customer": {} } or { "service": {} } when that is the current app behavior.