Getting Started

Welcome to the Cloudflow API. Use this reference when you are connecting Cloudflow services, customers, statuses, service types, service contacts, and market availability to another system.

Before You Start

You need:

• A Cloudflow organization on a plan that includes API access.
• An API key generated in Settings > API Access.
• A server-side integration environment where the key can be stored securely.

API key generation is currently gated to Business plan organizations in the Cloudflow app.

Make a First Request

Send your API key as a bearer token:

curl "https://app.cloudflowtechnology.com/api/services?limit=1" \
  -H "Authorization: Bearer cfk_your_api_key"

Cloudflow scopes API-key requests to the organization that generated the key. You usually do not need to send organizationId when using API-key authentication.

Response Shape

Most successful responses use a top-level data property. List endpoints also include meta pagination details:

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

Create endpoints may return the newly created named resource, such as { "service": {} } or { "customer": {} }, where that matches current Cloudflow behavior.

Next Steps

• Read the API overview.
• Review authentication.
• Browse the generated endpoint pages in the API Reference navigation after the Cloudflow OpenAPI definition syncs.