Installer.com Docs
Getting Started

Introduction

Overview of the Installer.com platform, architecture, and core concepts

What is Installer.com?

Installer.com is a property management and installation routing platform that connects routing operators, contractors, and end clients. The platform manages the complete lifecycle of installation orders — from creation and dispatching through scheduling, execution, and completion.

Typical use cases include solar panel installations, EV charger installations, heat pump installations, and other property-related services.

Architecture

The platform consists of several applications:

ApplicationURLPurpose
Routing Applocalhost:4300Main operator dashboard for managing orders and workflows
Auth Applocalhost:4400Authentication and user management
Client Portallocalhost:4201End-client view for tracking their orders
APIlocalhost:8000RESTful API serving all applications

Core Concepts

Organizations (Routers)

An organization (also called a router) is the top-level entity. Every API request is scoped to an organization via the routerId path parameter. Organizations manage their own:

  • Orders and order templates
  • Contractor partnerships
  • Workflow templates
  • Users and access control
  • Integrations and webhooks

Orders

Orders represent service requests — typically an installation, inspection, or maintenance job. Each order:

  • Belongs to an organization
  • Has custom fields defined by an order template
  • Follows a configurable workflow
  • Can have bookings, offers, notes, files, and chat threads attached

Workflows

Workflows define the sequence of steps an order goes through. Each step has a type (e.g., Dispatching, BookingCreate, Inspection) and a status. Workflow templates are configured per organization and can be customized with:

  • Step ordering and dependencies
  • Automated background events
  • Document templates
  • Offer configurations
  • Custom fields per step

Installers & Contractors

Installers are organized into contractor organizations that partner with routing operators. The dispatching system supports:

  • Direct assignment — assign to a specific installer
  • Broadcast dispatching — offer to multiple installers
  • Auto-dispatch — automatic assignment based on availability, location, and skills

Bookings

Bookings represent scheduled appointments tied to workflow steps. They include date/time, assigned installer, and can trigger notifications to all parties.

API Overview

The API follows REST conventions with JSON request/response bodies. Key characteristics:

  • Authentication: Bearer token via Authorization header
  • Multi-tenant: Organization is resolved from your API token
  • OpenAPI 3.1: Full specification available for code generation
  • Pagination: Cursor-based pagination on list endpoints
  • Real-time: Server-Sent Events (SSE) for live updates

Get an API token

Create an API token from Settings > API Tokens in the Routing App.

Make your first request

curl http://localhost:8000/api/v1/partners/installers \
  -H "Authorization: Bearer YOUR_TOKEN"

Or try it directly from the List Installers API reference page.

Explore the API

Browse the API Reference for all available endpoints.

Next Steps

On this page