ConnectCloud Developers

Environments and base URLs

Every module API lives under the ConnectCloud API host (api.). It serves the API only – no pages and no browser sign-in – so integrations do not depend on the address of the web app. The app (app.) answers the same paths for its own pages, but use the API host in integrations; the customer portal on portal. serves no API:

Environment Origin Use it for
Production https://api.mbcom.cloud your tenants' real data
Staging https://api.mbcom.cloud pre-release testing, by arrangement with MBCOM
Sandbox https://developers.mbcom.cloud/sandbox/<module> trying requests without an account, see Sandbox

A full URL is origin + base path + route:

https://api.mbcom.cloud/api/desk/v1/items/1234
└──────── origin ───────┘└─ base ──┘└ route ┘
Module Base path
HR /api/hr/v1
Desk /api/desk/v1
Forge /api/forge/v1
Comms /api/comms/v1
Trade /api/trade/v1
DMS /api/dms/v1
Master data /api/masterdata (no version segment)
CRM /api/crm/v1
Workflow /api/workflow/v1
Flows /api/flows/v1
Search /api/search/v1
Status /api/status/v1

API keys and tokens are bound to their environment: a production key does not work on staging.

Transport

  • HTTPS only. Plain HTTP is redirected and must never carry tokens.
  • Request and response bodies are JSON (Content-Type: application/json, UTF-8) unless an endpoint documents otherwise (file uploads use multipart/form-data, downloads their own type).
  • Timestamps are RFC 3339 in UTC (2026-03-02T09:30:00Z), dates are YYYY-MM-DD.
  • Identifiers are opaque strings (mostly UUIDs). Do not parse them.
  • New fields may appear in responses at any time; ignore fields you do not know.

Status and incidents

The current availability of every environment is shown on the status page, including incidents and planned maintenance. To check the modules of an environment from your own monitoring, call GET /api/status/v1/modules: it needs no token and returns up, degraded, down or unknown per module.

View as Markdown