ConnectCloud Developers

ConnectCloud API · v1

Build on ConnectCloud

REST APIs for tickets, people, documents, master data, workflows and notifications, with one way to authenticate, one error format and signed webhooks. Try every endpoint in the sandbox, no account needed.

APIs

HR

Employees, roles and groups, absences and vacation accounts, working time, travel expenses and the organisation chart. Also issues the access tokens for every other API.

/api/hr/v1 · 173 operations · v1.0.0

Desk

Tickets, issues and tasks with configurable spaces, types, workflows and fields; comments, mail, attachments, SLAs, automation rules, projects and their payment plans.

/api/desk/v1 · 166 operations · v1.0.0

Forge

Software development: projects with linked repositories, items (APP-12) with sections, links, milestones, iterations and the backlog, views, automations, and the handoff and conversion of items to and from desk.

/api/forge/v1 · 132 operations · v1.0.0

Comms

Outgoing mail and webhooks: channels, templates, the delivery log, inbound webhooks and mailboxes.

/api/comms/v1 · 35 operations · v1.0.0

DMS

Documents with versions, links to records, text extraction, containers, compliance (audit, legal hold) and exports.

/api/dms/v1 · 58 operations · v1.0.0

Trade

Offers, orders, invoices and credit notes, contracts, purchase orders and goods receipts, inbound invoices with their checks, MSP and ITSP (distributor catalog) and the trade settings.

/api/trade/v1 · 169 operations · v1.0.0

Master data

Addresses (customers, suppliers) with contacts and postal addresses, articles, product groups, lookup tables, number ranges and the tenant profile.

/api/masterdata · 60 operations · v1.0.0

CRM

Leads, campaigns, opportunities and customer satisfaction (CSAT), the customer timeline of calls and meetings, address quality checks and the NFON phone book settings.

/api/crm/v1 · 48 operations · v1.0.0

Workflow

Approval workflows: blueprints, the tasks of a person, running instances and the tenant's workflow configuration.

/api/workflow/v1 · 33 operations · v1.0.0

Flows

Automation: flows as YAML graphs of triggers (events, schedules, manual starts, webhooks) and nodes (module actions, conditions, human tasks, waits, loops, sub-flows, mail, AI); drafts, validation, test runs, publishing, runs with their node history and the task inbox.

/api/flows/v1 · 31 operations · v1.0.0

Search

Full-text search over the tenant's desk, CRM, master data, trade, knowledge, HR and comms records and its DMS documents.

/api/search/v1 · 2 operations · v1.0.0

Status

Whether the modules of the environment are working: one public request, no token.

/api/status/v1 · 1 operations · v1.0.0

First call in three steps

  1. Create an API key in the portal (Einstellungen › Anmeldung & Sicherheit › API-Schlüssel) or a service account.
  2. Exchange it for a 15-minute access token:
    curl -X POST https://api.mbcom.cloud/api/hr/v1/auth/token \
      -H "Authorization: Bearer $CONNECTCLOUD_API_KEY"
  3. Call any API with the token:
    curl https://api.mbcom.cloud/api/desk/v1/items?limit=10 \
      -H "Authorization: Bearer $ACCESS_TOKEN"

Ready for AI agents

Connect your coding assistant to the read-only documentation server, or point it at llms.txt. Every page also exists as Markdown.

claude mcp add --transport http connectcloud-docs https://developers.mbcom.cloud/mcp

MCP tools, agent skill and setup for other clients →

Guides

  • IntroductionWhat the ConnectCloud API offers, how it is organised and where to start.
  • QuickstartCreate an API key, exchange it for an access token and make your first call.
  • AuthenticationAPI keys, service accounts, short-lived access tokens, permissions and tenants.
  • Environments and base URLsProduction, staging and sandbox origins, base paths and transport requirements.
  • ErrorsThe error shape, HTTP status codes, error codes and what to retry.
  • Pagination and delta syncCursor and offset pagination, limits, sorting and syncing changes with updatedSince.
  • Idempotency and concurrencySafe retries with Idempotency-Key and dedupeKey, and optimistic locking with version.
  • Rate limitsRequest limits per principal and route, the 429 answer and how to stay below them.
  • WebhooksReceive signed events when tickets, absences or documents change, verify signatures, and send events into ConnectCloud.
  • Versioning and changesHow the API is versioned, what counts as a breaking change and how deprecations are announced.
  • SandboxTry every endpoint against example answers without an account, from the browser, curl or an AI agent.
  • AI agentsLet coding assistants and AI agents read this documentation through MCP, llms.txt, Markdown pages and an agent skill.
  • Careers APIShow a tenant's open positions on your own website and take applications without a token.
  • Projects, plans and billingCreate desk projects from templates, plan milestones and dependencies, react to delays, bill payment plans through trade and read the hours booked in HR.
  • Handoff and conversionHand desk tickets and forge items over to each other (Übergabe), hand them back (Zurückgeben) and convert them (Umwandeln), with idempotency, delivery states and events.
  • FlowsBuild automations as YAML – validate, test (dry by default), publish, start by hand or by webhook, send mail, follow runs and answer tasks; templates with parameters, flows of a desk space or forge project and the immediate automations of desk and forge.
  • Work entries (HR)Book work (Leistungen) in HR as a length, with start and end or with a stopwatch, attach it to a subject, approve it and bill approved work to trade in batches.
  • Documents (DMS)Upload documents to the DMS, file them in folders, wait for the malware scan, add versions, link them to records and download them.
  • Sales documents and e-invoices (Trade)Create offers and orders, deliver and invoice them, issue XRechnung e-invoices, process inbound e-invoices and handle the workflow lock (423 workflow_locked).
  • Desk ticketsRead the tenant's desk configuration from the bootstrap endpoint, create tickets, move them through their workflow, reply by comment or mail and add attachments.
  • Addresses and articles (master data)Read and write customer and supplier addresses and articles, and keep an external system such as a CRM, shop or ERP in sync with paging and change detection.
  • Leads and opportunities (CRM)Capture leads with duplicate checks, convert them into master data customers with a first opportunity, and move opportunities through the tenant's pipeline to won or lost.
  • Forge itemsRead a forge project's configuration, create items such as APP-12, search them across projects and move them through the project's workflow by status or status category.
  • Mail, channels and the delivery log (Comms)What the comms module offers API clients – mail and webhook channels, the delivery log with retries, receiving mailboxes and the Belegeingang address – and how mail is sent from a client's point of view.