API

Articles

Open API
Overview The service minder  open API is designed primarily to support integrations for websites and call centers. Reporting There are three ways to use your data within service minder  in outside reporting, analytic tools.  API Wareh...
Organization-Level Download API
Overview The Download API allows individual franchise locations to automate data extraction without requiring setup at the brand level. This means an organization (franchisee) can configure its own API access independently, which is especially ...
DataSubscriber Download API
Overview As with all things in service minder , there are settings controlled by the organization and higher levels of control at the brand-level. The distinction between organization (franchisee) and brand (franchisor) allows for separation of w...
DataSubscriber Feed API
Overview As with all things in service minder , there are settings controlled by the organization and higher levels of control at the brand-level. The distinction between organization (franchisee) and brand (franchisor) allows for separation of wha...
API Key Configuration
Overview An application programming interface (API) key is a code used to identify and authenticate an application or user . API keys are used extensively by many brands and organizations in service minder . They act as a unique identifier and p...
API Payload Examples
Lead Capture - Add/Update Contacts Endpoint:  https://serviceminder.io/api/contacts/addupdate Example payload: { "Matches": [{ "Name": "Testing SM", "Phone": "785-555-5555", "Zip": "12345", "Email": "te...
Building a Data Warehouse
Overview In order for a brand to have custom reporting against your service minder data, the data needs to be pulled out of service minder and loaded into a different database. Depending on how "current" the brand wants data to be, there are a ...
API - Data Warehouse and Appointments
Recurring Appointments When it comes to Recurring Appointments , this is an area where the data warehouse is a bit stronger. Due to recurring appointments functionality, the system is constantly making and deleting appointments, so they aren't...
Appending Contact Data Using Forms
API - Updated Contact Data Using Forms Data may be posted directly to service minder .com to append existing information. For example, if there is a series of custom fields that need to be updated in contacts, this method may be used. The URL th...
Download Paging
Overview The following psuedocode describes a typical approach for implementing paging with our download API. At a high level, this builds a list of downloads that are monitored until they complete. As each download completes, you will get the ma...
Lead Distribution
Overview Lead distribution is the process that enables new leads to be distributed directly to the organization that owns the zip/postal code included in the lead data. Within a brand, you will assign with postal codes are owned by each location...