Successware API
Successware is a cloud-based, all-in-one business management platform built for home services trades—HVAC, plumbing, electrical, solar, roofing, septic, and chimney. It unifies call booking, CRM, dispatching and scheduling, field mobile tools, payments, inventory, and integrated accounting. An unofficial API lets you programmatically pull jobs, customers, technicians, invoices, equipment, and inventory—and push updates like new jobs, dispatch changes, invoices, and payment records back into Successware.
What is Successware?
Successware is a cloud-based, all-in-one business management platform built specifically for small and medium-sized home services companies. Trades businesses use Successware to handle call booking and CRM, dispatching and scheduling, field mobile work, payments, inventory, and integrated back-office accounting—in a single system that synchronizes data between field devices and the office.
It serves HVAC, plumbing, electrical, solar, chimney sweep, septic service, indoor air quality, and roofing companies. Core product areas include:
- Call Booking & CRM (lead capture, customer records, scheduling intake)
- Dispatching & Scheduling (technician assignment, calendar, real-time dispatch board)
- Successware Mobile (field app with offline mode, job detail, equipment history, mobile invoicing)
- Successware Payments (digital invoicing and integrated payment processing)
- Integrated Accounting & Back-Office Management (general ledger, AR/AP, payroll integrations)
- Inventory Management (parts, materials, price books)
Common data entities:
- Jobs, Work Orders, Service Calls, Appointments
- Customers, Locations, Contacts, Service History
- Technicians, Dispatch Assignments, Calendars
- Invoices, Payments, Estimates, Price Book Items
- Equipment, Parts, Inventory, Materials
- Recurring Service Agreements and Maintenance Plans
The Successware Integration Challenge
Home services contractors run their entire operation on Successware daily, but turning its portal- and mobile-driven workflows into API-driven automation is non-trivial:
- Limited public API: Successware emphasizes packaged third-party integrations over a documented, openly available developer API, so most data access flows through the web platform and mobile app
- Mobile-first field data: Job updates, technician notes, photos, and signatures originate in Successware Mobile—including offline-captured records that sync later—making real-time access harder
- Partner-gated integrations: Many connections (ADP, QuickBooks Payroll, CompanyCam, payments, scheduling) are pre-built partner integrations rather than a general-purpose API surface
- Integrated accounting coupling: Jobs, invoices, payments, and inventory are tightly linked to the back-office ledger, so writes must respect accounting rules and posting states
- Legacy and new platform split: Customers may run the established SuccessWare21 system or the newer cloud platform, each with different object models and access paths
- Price book and dispatch complexity: Flat-rate pricing, dispatch boards, and recurring service agreements require careful handling to keep field and office data consistent
How Supergood Creates Successware APIs
Supergood reverse-engineers Successware's authenticated web and mobile flows to deliver a resilient API layer for your Successware account—across call booking, dispatch, field, invoicing, and inventory—without waiting on a public developer program.
- Handles username/password and MFA securely within a managed session
- Maintains session continuity with automated refresh and change detection across web and mobile surfaces
- Normalizes responses across Jobs, Customers, Technicians, Invoices, and Inventory so you integrate once and rely on consistent objects
- Respects integrated-accounting posting rules and price book configuration to ensure compliant writes
Use Successware with AI agents: Successware MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Successware modules, platform version, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready Successware adapter tailored to your account configuration and price book.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Successware evolves.
API Endpoints
Authentication
/authenticateAuthenticate to a Successware account using username/password, or MFA, and obtain a session token for downstream calls.
Jobs
/jobsList jobs, service calls, and work orders with filters for status, technician, date range, and customer.
Jobs
/create_jobCreate a new job or service call against a customer and location with scheduling and price book details.
Customers
/customersRetrieve customers, locations, contacts, and service history for CRM and dispatch workflows.
Dispatch
/techniciansList technicians, dispatch assignments, and calendar availability across the dispatch board.
Billing
/invoicesPull invoices, estimates, payments, and price book line items synced with integrated accounting.
Use Cases
Sync job and dispatch data into your stack
- Pull active jobs, service calls, and technician assignments into a warehouse or BI tool - Stream job-close and status-change events to downstream reporting and customer-experience systems - Reconcile customer, location, and service-history records for a unified customer 360
Automate invoicing and payment reconciliation
- Sync invoices, estimates, and payments from Successware into accounting and AR systems - Match Successware Payments transactions against the integrated ledger - Surface unpaid invoices and aging balances to collections workflows
Keep field and office data in sync
- Push new jobs and dispatch changes from your CRM or scheduling tool into Successware - Pull mobile-captured updates, equipment history, and notes back for downstream automation - Trigger follow-up workflows when a technician closes a job in the field
Manage inventory and price book programmatically
- Pull parts, materials, and inventory levels for replenishment and reporting - Sync flat-rate price book items across estimating and quoting tools - Surface low-stock and recurring-service-agreement renewals to operations
Technical Specifications
Authentication
Username/password and MFA handled in a managed session
Connectivity
Authenticated web and mobile flows surfaced as a clean REST-style API
Response format
Normalized JSON across Jobs, Customers, Technicians, Invoices, and Inventory objects
Rate limits
Adaptive throttling tuned to your account to avoid platform-side limits
Session management
Automatic session refresh, MFA replay handling, and credential rotation
Data freshness
Near real-time pulls for jobs, dispatch, and invoices with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for job creation, dispatch changes, job close, and payment events
Latency
Sub-second reads on cached entities; multi-second writes when posting jobs and invoices
Throughput
Horizontally scaled workers sized to multi-branch field service volume
Reliability
Retry, backoff, and idempotency keys for job, invoice, and payment writes
Adaptation
Continuous monitoring of Successware platform releases and configuration drift across SuccessWare21 and the new cloud platform
Frequently asked questions
Successware emphasizes packaged third-party integrations over a broadly documented public developer API. Supergood works with your existing authenticated Successware sessions to expose jobs, customers, invoices, and inventory programmatically without waiting on a public developer program.
Yes. Supergood adapts to either deployment. We profile your specific platform version and operate against the same authenticated surfaces, normalizing the differing object models into a consistent API.
Yes. Job updates, technician notes, equipment history, and signatures captured in Successware Mobile—including offline records that sync later—are exposed through the same normalized API surface alongside office data.
Supergood respects Successware's integrated-accounting posting rules and price book configuration. Invoice, payment, and estimate writes follow the platform's accounting states rather than forcing a generic schema.
No. Supergood works with your own Successware credentials and entitlements. You do not need a separate partner-integration agreement to access your own account's data.