docs
/
Documentation

Developers

Build on the backend — how the platform is put together, the API surface, how a client consumes it, and the services it connects to.

Platform

Architecture, tenancy, identity and the data model shared by every product.

AppEngine API

The backend API — conventions, authentication, the data layer and every module.

ConventionsHeaders, response envelopes, paging, error shapes, limits — the rules that hold across every endpoint.API reference and discoveryThe browsable reference, the machine-readable surfaces behind it, and the path an agent follows to find one endpoint out of 3,036.API directoryEvery API area with a direct link to its specification — 161 sections, grouped, not one list.MCP serverConnect an AI client to AppEngine over the Model Context Protocol — discover services, read their signatures, and call them.User authenticationOperator sign-in, invitations, password management and session endpoints.Customer authenticationSign-up, sign-in, password reset and social login for the end users of a tenant.API keysLong-lived credentials for server-to-server access, and how they resolve to a user.Two-factor and device security2FA setup and verification, device fingerprinting, trust and blocking, and login history.OAuth and social loginGoogle, Facebook, GitHub and Microsoft — redirect flows and native token exchange.The repositoryOne generic controller that serves create, read, update and delete for all 261 datatypes.Files and mediaUpload, thumbnails, signed URLs, privacy, and the org-scoped storage layout.Collections and schemasDefining your own datatypes, how schemas drive both validation and UI, and repairing a collection.Lifecycle, history and approvalState transitions, versioning, restore from history and trash, and per-record permissions.Bulk, export and migrationImporting many records, streaming exports, and moving data between collections.Pages and renderingThe four shapes a page record can take, how the renderer chooses between them, where page CSS and JavaScript live, and how to write a page without losing what was there.SitesThe site record — the home page, hosts and domains, logo and favicon, tracking and SEO — and the two fields whose shape is not what you would expect.CRMLeads, pipelines, campaigns, ads, tickets, reservations, signed documents and the AI assistant.Storefront and commerceCatalog, cart, checkout, payments, orders, POS, inventory, pricing, discounts, returns, rentals and tax.Sales channelsSelling the same catalog on Amazon, eBay, Etsy and elsewhere — mappings, inventory sync, order aggregation and pricing.BusinessMadeThe endpoints behind BusinessMade — people, time, pay, benefits, bills and the ledger.Events and ticketingEvents, ticket types, sessions, QR validation, badges, credentials, check-in and event media.BankingBank linking for the books — connect accounts through Plaid, read balances and transactions, and reconcile them. Read-only; no money moves.Wallets, payouts and paymentsInternal balances, payout workflow, and gateway-agnostic payment operations.Automation and workflowEvent-driven automations, AI-generated flows, and the generic task workflow engine with SLAs.AIChat, agents, MCP tools, image and video generation, AI employees, voice, and API discovery through MCP.Messaging, phone and SMSPhone numbers, inbound call routing, SMS keywords and auto-replies, email broadcast and live chat.Platform operationsUsage metering and token balances, monitoring and analytics dashboards, vendor connections, upstream integrations and cluster management.Product attributesThe two-layer model behind configurable products — the reusable definition, the per-product subset, every attribute type, file uploads, the required rule and how option prices reach the order.Content StudioPosts taken page by page — courses, applications, trainings, documentation — with outline, access, progress, answers, marking and review.CommunityPages, posts, stories, follows, connections, direct and group messaging, meetings, blocking and reporting, plus social-listening topics.StowboSpace custody — listings, carts and holds, bookings with per-item sessions, movements, delegated pickups, fees, settlement and host payouts.Logistics and deliveryDelivery jobs, pricing quotes, zones, drivers, live tracking, proof of delivery, customer orders with payment, and driver earnings and payouts.WorkspacesTeam workspaces and conversations — members, a journal of messages, files, tasks, meetings and agendas, with a personal Home, Inbox, My Tasks and My Calendar.Client account (client-data)The signed-in customer's own account — profile, orders, forms, reservations, tickets, messages, addresses, wishlists, files, benefits, shared accounts and payment links.ApprovalsAsking for access to a screen or a guarded operation, and deciding it from a tray, through the org's workflows.HandlingWho is dealing with a record — take it, finish it, give it back — on any datatype, for people and AI employees alike.Creative StudioThe design library and the editor's save path — searched and paged listings, new designs, saves, copies, previews and uploaded images.Staff directoryEveryone who works in the org — people and AI employees — with what a colleague needs to reach them.Device integrationsThe server side of Device Hub — hub keys and live state, remote peripheral config, device calls, and the event stream back to screens.PrintRender a record as a full-page PDF or as thermal receipt lines, from built-in templates.

Client Integration

How an application consumes AppEngine — the call path, authentication, the browser runtime and realtime.

QuickstartYour first working call, then sign in a customer, list products, price a cart and place an order — with runnable requests and real responses.Build a web storeBuild a working storefront on AppEngine from an empty folder — catalog, cart, promo codes and a total you can charge, explained decision by decision.TypeScript clientA complete walkthrough — install the client, stand up a proxy, render a catalog, and price a cart the server can vouch for.Example appsClone the example repository, point it at your organization, and have a working storefront running in a few minutes.Flutter clientThe package that talks to AppEngine from Flutter — app authentication, staff and customer sign-in, and reads and writes over any datatype.Flutter tutorialBuild a working Flutter app on AppEngine from an empty folder — sign-in, verification codes, a session and a real read — in about twenty minutes.Flutter authTwo kinds of people, three endings to a sign-in, verification codes, shared devices and remembered accounts.Flutter requestsReads and writes over any datatype, the escape hatch for everything else, and what the errors mean.Flutter offlineCaching reads, queueing writes, and being honest about what cannot work offline.EndpointsThe endpoints a client application actually calls — auth, catalog, cart, checkout, orders, and the customer-scoped client/* surface.ErrorsThe error envelope, the codes you must handle, and what each one actually means.AuthenticationApplication credentials, the tenant header, and how a signed-in visitor's identity is carried to AppEngine without exposing anything to the browser.Server proxyThe pattern that puts your own server between the browser and AppEngine, with the working implementation from base-app.Browser runtimewindow.appmint — the JavaScript API that HTML pages and no-code markup use to reach the platform, and how it bridges to the host application.Realtime & chatThe WebSocket surface — connecting, authenticating, the event vocabulary, and why this is the one case that talks to AppEngine directly.

Integrations

One API, webhooks, connectors and third-party services.