All docs

Getting started

From zero to a working business

Create an organization, install a ready-made setup, and hand a client a clean workspace — usually in an afternoon. Here is the whole path.

The shape of it

polimorf has two sides. The build console is where you (an agency or operator) assemble the software a business runs on — its records, automatic tasks, reports, and team access. The client workspace is the clean, role-scoped place you hand the business to run the day. You build once; they run on it.

Each organization is walled off in its own database. You can run as many as you like — one per client — from a single account.

1 · Create a developer account

Sign up at /signup. A developer account lands you in the launchpad at /app/dev, where you create and switch between organizations. TOTP-based two-factor is available from day one.

Creating an organization provisions a fresh, isolated database for it in seconds. Name it, pick a region, and you are in.

2 · Install a ready-made setup

Rather than model everything by hand, start from a blueprint — a ready-made setup for a kind of business. Each one brings its data models, automatic tasks, dashboards, and navigation as one working package. Browse the catalog, opt in or out of each part on install, and customize from there.

Installation runs as a single transaction with cascade rollback: if anything fails halfway, the organization returns to its prior state — never a half-installed mess.

3 · Invite your client

Send a role-scoped invitation from the members area. The recipient gets the client workspace: only the records, reports, and navigation their role allows — nothing to misuse, and no view into any other organization.

Account typeLands inSees
Developer/app/devEvery organization you build, the full build console
Client/app/overviewOne organization, scoped to the role you granted

Access is invite-only — there are no public sign-ups into an organization, so a client can never appear without you adding them.

Drive it from code

Every data model you define gets a REST surface automatically. Authenticate with a bearer token and call it directly:

bash
# Exchange credentials for a short-lived access token
curl -X POST https://api.polimorf.com/admin/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email": "you@agency.com", "password": "…"}'

# Use the returned token against any of your schemas
curl https://api.polimorf.com/admin/v1/content/orders \
  -H 'Authorization: Bearer <access_token>'

See the API reference for the full auth flow, organization scoping, dynamic endpoints, and pagination.

Where to next

Three good directions from here:

  • Core concepts — organizations, personas, and how isolation actually works.
  • Schema designer — model your own data with field types, traits, and migrations.
  • Workflows — make the busywork run itself.