Skip to content

api-evangelist/simpro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simpro (simpro)

Simpro (simPRO) is field service management and project/business management software for the trades - electrical, plumbing, HVAC, security, fire, and other contractors. It covers estimating, quoting, job management, scheduling and dispatch, asset maintenance, inventory and catalog, purchasing, timesheets, and invoicing.

Access Model (Read This First)

Simpro's REST API v1.0 is not a shared, self-service public API. It is a capability of a Simpro Premium subscription, and every point of access is scoped to a specific customer build:

  • Per-build host. The API is served from the customer's own build subdomain - https://{build}.simprosuite.com/api/v1.0 - the same domain used to log in to the Simpro staff portal. There is no single global API endpoint.
  • Customer-provisioned credentials. Authentication is OAuth2. An account administrator registers an API application on the build and issues client credentials; the integration then requests access tokens from https://{build}.simprosuite.com/oauth2/token and sends them as Authorization: Bearer ACCESS_TOKEN. Both the client credentials and authorization code grants are supported.
  • Company-scoped resources. Almost every resource is nested under a company: /api/v1.0/companies/{companyID}/..., where companyID is 0 on single-company builds and >= 0 on multi-company builds.
  • Rate limit. 10 API calls per second, scoped to the whole build (shared across companies and integrations). Over-limit requests return HTTP 429.

The catalog entry here models a representative subset of the API. The full published reference spans 300+ resource types.

APIs.json: https://raw.githubusercontent.com/api-evangelist/simpro/refs/heads/main/apis.yml

Tags

  • Field Service Management
  • Trades
  • Job Management
  • Project Management
  • Scheduling
  • Inventory
  • Estimating
  • Workforce
  • SaaS
  • Contractors

Timestamps

  • Created: 2026-07-12
  • Modified: 2026-07-12

APIs

All APIs share the per-build base URL https://{build}.simprosuite.com/api/v1.0 and are documented at the Simpro Developer Center.

Simpro Companies API

List and retrieve the companies configured on a Simpro build. The company is the top-level scope for nearly every other resource.

Tags

  • Companies
  • Configuration

Properties

Simpro Customers API

Create, list, retrieve, update, and delete company (organization) and individual customers - the entities that receive invoices for work performed.

Tags

  • Customers
  • CRM

Simpro Sites API

Manage customer sites and service locations that jobs, quotes, and assets are associated with.

Tags

  • Sites
  • Locations

Simpro Jobs API

Create, list, retrieve, update, and delete jobs - the core unit of field service work, tracking scheduling, stock, vendor orders, contractor work orders, customer assets, forms, and totals.

Tags

  • Jobs
  • Work Orders
  • Field Service

Simpro Quotes API

Create, list, retrieve, update, and delete quotes and estimates, including their totals. Quotes convert to jobs within Simpro.

Tags

  • Quotes
  • Estimating

Simpro Invoices API

Create, list, retrieve, update, and delete customer invoices raised from jobs and projects.

Tags

  • Invoices
  • Billing

Simpro Schedules API

List and retrieve schedule records - the assignments of staff to jobs and activities that drive field workforce planning.

Tags

  • Scheduling
  • Dispatch

Simpro Vendor Orders API

Create, list, retrieve, update, and delete vendor (purchase) orders raised to suppliers for materials and stock.

Tags

  • Purchasing
  • Vendor Orders

Simpro Cost Centers API

Manage accounting cost centers under company setup that job and project financials are allocated against.

Tags

  • Accounting
  • Cost Centers
  • Setup

Simpro Stock API

List and retrieve catalog stock items held on storage devices (warehouses, vans, and other locations).

Tags

  • Inventory
  • Stock
  • Catalog

Simpro Webhooks API

Create, list, retrieve, update, and delete webhook subscriptions. Simpro POSTs HTTPS callbacks to your endpoint on subscribed build events - server-to-endpoint HTTP, not a streaming or WebSocket transport.

Tags

  • Webhooks
  • Events
  • Notifications

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors