ServicePro API Documentation

Home / API Documentation

API	Description
GET api/v1/Account/GetAccountByAccountNum?accountnum={accountnum}	Get Account Info By Account Number
GET api/v1/Account/GetAccountByAccountId?accountid={accountid}	Get Account Info By Account Id
GET api/v1/Account/GetLatestEstimateId?accountid={accountid}	Get the Latest EstimateId by Account
GET api/v1/Account/GetAccountsList?page={page}	Get List Of All Accounts Information
GET api/v1/Account/GetAccountListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Account List By Company
GET api/v1/Account/GetAccountListLastChangedByCompany?companyid={companyid}&utclastchanged={utclastchanged}&page={page}&pagelimit={pagelimit}	Get Account List By UtcLastchanged By Company
GET api/v1/Account/GetContactByAccountId?accountid={accountid}&showadditionalcontact={showadditionalcontact}	Get Primary (Additional) Contact Account Information by Account Id
GET api/v1/Account/GetContactByContactId?contactid={contactid}	Get Contact Info by Contact Id
GET api/v1/Account/GetContactsByPhoneNumber?phoneNumber={phoneNumber}	Get Contacts by PhoneNumber
GET api/v1/Account/GetContactPhoneNumberByPhoneId?phoneid={phoneid}	Get Contact PhoneNumber Info by Phone Id
GET api/v1/Account/GetAddressByAddressid?addressid={addressid}	Get Address Info by Address Id
GET api/v1/Account/GetSiteAddressByPhoneNumber?companyId={companyId}&phoneNumber={phoneNumber}	Get Site Address Info by Phone Number
GET api/v1/Account/GetSensorByAccountId?accountid={accountid}&startdate={startdate}&enddate={enddate}	Get the Sensors Activity by AccountId
GET api/v1/Account/GetDetailedListOfAccountWithActivePrograms?asofdate={asofdate}&companyid={companyid}	Get Detailed Account List With Active Programs
GET api/v1/Account/GetDetailedListOfAccountWithCancelledPrograms?fromdate={fromdate}&todate={todate}&companyid={companyid}	Get Detailed Account List With Cancelled Programs
POST api/v1/Account/PostCreateAccount	Create Account With Site
POST api/v1/Account/PostCreateAllInAccount	Creating Account, Site, Estimate, Program, Event and WO
POST api/v1/Account/PostCreateAccountAndEstimate	Create Account with site and Estimate
POST api/v1/Account/PostCreateAccountWithNote	Create Account With Site and Account Note
POST api/v1/Account/PostCreateNoteOnAccount	Create Private Note on specific account
POST api/v1/Account/PostBatchCreateProspects	Create Multiple Prospects
POST api/v1/Account/PostEPAAccount	Create EPA ACCOUNT
GET api/v1/Account/GetActiveCustomersDetailsByRouteByProgram?startdate={startdate}&asofdate={asofdate}&branchID={branchID}&sortby={sortby}&dateformat={dateformat}&companyid={companyid}	Get Active Customers Detail by Route by Program
POST api/v1/Account/PostEncryptAccountID	Encrypted Account Info
POST api/v1/Account/UpdateContact	Update contact
POST api/v1/Account/AddAdditionalContact	Add additional contact to account
POST api/v1/Account/UpdateAdditionalContact	Update additional contact

API	Description
POST api/v1/ContactLog/PostCreateContactLog	Create Contact Log
POST api/v1/ContactLog/PostCallAnswerCreateContactLog	Create contact log from call asnwer
POST api/v1/ContactLog/PostCallAnswerCreateContactLogWithNote	Create contact log from call answer with note
POST api/v1/ContactLog/PostCreateContactLogType	Create a new record of contact log type
GET api/v1/ContactLog/GetContactLogSource?SourceId={SourceId}	Get Contact Log Source by Id
GET api/v1/ContactLog/GetContactLogSourceByName?sourcename={sourcename}	Get contact log source by name
GET api/v1/ContactLog/GetContactLogType?TypeId={TypeId}	Get contact log type by Id
GET api/v1/ContactLog/GetContactLogTypeByName?typename={typename}	get contact log type by name

API	Description
GET api/v1/Employees/GetEmployeesListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Employees List By Company

API	Description
GET api/v1/Event/GetEventsSoldBySaleDate?from={from}&to={to}&companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Events Sold By SaleDate

API	Description
GET api/v1/Inventory/GetInventoryListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Inventory Item List By Company
GET api/v1/Inventory/GetProductsByNotCompletedWOByDateRange?fromdate={fromdate}&todate={todate}&companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Products used per job on not completed WOs
GET api/v1/Inventory/GetProductsByCompletedWOByDateRange?fromdate={fromdate}&todate={todate}&companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Products used per job on completed WOs

API	Description
POST api/v1/Program/PostCreateProgram	Post request, create a new program
GET api/v1/Program/GetDetailedSoldProgramsBySaleDate?fromdate={fromdate}&todate={todate}&companyid={companyid}	Get Detailed Sold Programs By Sale Date
GET api/v1/Program/GetEncryptProgramCOPInfo?programId={programId}&amount={amount}	Encrypt Program COP Info
GET api/v1/Program/GetReinstatedProgramsByReinstateDate?fromdate={fromdate}&todate={todate}&companyid={companyid}	Get Reinstated Programs By Reinstate Date
GET api/v1/Program/GetProgramsListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Program List By Company

API	Description
GET api/v1/Token/GetAuthenticationToken?username={username}&password={password}	Get Authentication Token
POST api/v1/Token/PostAuthenticationToken	Post Request to Get Authentication Token

API	Description
GET api/v1/Invoice/GetInvoiceListByDateRange?from={from}&to={to}&companyid={companyid}	Get Invoice List By DateRange
GET api/v1/Invoice/GetInvoiceListByModifiedDateRange?from={from}&to={to}&companyid={companyid}	Get Invoice List By Modified DateRange
GET api/v1/Invoice/GetInvoiceDetailsByDateRange?from={from}&to={to}&companyid={companyid}	Get Invoice Details by Date Range
GET api/v1/Invoice/GetInvoiceDetailsById?invoiceId={invoiceId}&companyid={companyid}	Get Invoice Details by invoiceId
GET api/v1/Invoice/GetInvoiceDetailsLastChangedByDateRange?from={from}&to={to}&companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Invoice Details by Date Range comparing with utclastchanged
GET api/v1/Invoice/GetRemovedInvoiceByDateRange?from={from}&to={to}	Get Removed Invoices by Date Range comparing with logutctimestamp
GET api/v1/Invoice/GetCreditReversals?from={from}&to={to}	Get Credits Reversed
GET api/v1/Invoice/GetOwedInvoicesDetailsByDate?from={from}&to={to}&companyid={companyid}	Get Owed Invoices Details by Date Range
GET api/v1/Invoice/GetPaymentsByType?from={from}&to={to}&companyid={companyid}&paymethod={paymethod}	Get payments by date range
GET api/v1/Invoice/GetInvoiceTotalsByEvent?companyid={companyid}&fromdate={fromdate}&todate={todate}	Get Invoice Totals By Events

API	Description
GET api/v1/WorkOrder/GetAllWorkOrdersByScheduleDateRange?from={from}&to={to}&page={page}	Get All WorkOrders by Scheduled Date Range
GET api/v1/WorkOrder/GetWorkOrderListByScheduleDateRange?from={from}&to={to}&page={page}	Get List of WorkOrders by Scheduled Date Range
GET api/v1/WorkOrder/GetWorkOrderListByRouteByScheduleDateRange?routename={routename}&from={from}&to={to}&page={page}	Get List of WorkOrders by Routename and Scheduled Date Range
GET api/v1/WorkOrder/GetWorkOrderListBlockTimeListByRouteAndScheduleDateRange?routename={routename}&from={from}&to={to}	Get List of WorkOrders and Block Time Info by Routename and Scheduled Date Range
POST api/v1/WorkOrder/PostUpdateWorkOrder	API Call for updating the WOs
GET api/v1/WorkOrder/GetWorkOrderListByCompany?companyid={companyid}&page={page}&pagelimit={pagelimit}&languageid={languageid}	Get Work Order List by Company
GET api/v1/WorkOrder/GetCompletedWorkOrderListByDateRange?companyid={companyid}&fromdate={fromdate}&todate={todate}&languageid={languageid}	Get Complete Work Order List By Date Range and Company
GET api/v1/WorkOrder/GetCompletedWorkOrderListByLastChangedByDateRange?companyid={companyid}&fromdate={fromdate}&todate={todate}&languageid={languageid}&page={page}&pagelimit={pagelimit}	Get All Work Orders By Date Range and Company
POST api/v1/WorkOrder/PostWorkOrderListByOptions	Get Work Order List by diferents options
GET api/v1/WorkOrder/GetDetailedWorkOrderListByScheduleDateRange?from={from}&to={to}&companyid={companyid}	Get Detailed List of WorkOrders by Scheduled Date Range
GET api/v1/WorkOrder/GetWorkOrderByID?workorderid={workorderid}	Get WorkOrder by WorkOrderID
GET api/v1/WorkOrder/GetWorkOrderListByAccountID?accountid={accountid}&page={page}	Get List of WorkOrders by AccountID
GET api/v1/WorkOrder/GetWorkOrderListByAccountNum?accountnum={accountnum}&page={page}	Get List of WorkOrders by Account Number
GET api/v1/WorkOrder/GetWorkOrderListByCompletedDateRange?from={from}&to={to}&companyid={companyid}&propertytypename={propertytypename}&routes={routes}&excludepropertytype={excludepropertytype}&excluderoutes={excluderoutes}	Get WorkOrder List By Completed DateRange
GET api/v1/WorkOrder/GetDetailedWorkOrderListByCompletedDateRange?from={from}&to={to}&companyid={companyid}&propertytypename={propertytypename}&routes={routes}&excludepropertytype={excludepropertytype}&excluderoutes={excluderoutes}	Get Detailed WorkOrder List By Completed DateRange
GET api/v1/WorkOrder/GetServicesByCompletedDate?from={from}&to={to}&companyid={companyid}&page={page}	Get Services By Completed Date
GET api/v1/WorkOrder/GetServiceTicketsByScheduledDateRange?from={from}&to={to}&companyid={companyid}	Get ServiceTickets By Scheduled DateRange
GET api/v1/WorkOrder/GetContractListByAccountID?accountid={accountid}&page={page}	Get List of Contracts/Programs by Account ID
GET api/v1/WorkOrder/GetContractListByAccountNum?accountnum={accountnum}&page={page}	Get List of Contracts/Programs by AccountNum
GET api/v1/WorkOrder/GetContractByID?programid={programid}&page={page}	Get Contract/Program by Program ID
GET api/v1/WorkOrder/GetContractListByStartDateRange?from={from}&to={to}&companyid={companyid}	Get Contract List By Start DateRange
GET api/v1/WorkOrder/GetDetailedNotServicedWorkOrderListByScheduleDateRange?from={from}&to={to}&companyid={companyid}	Get Not Serviced WorkOrder Detailed List By Schedule Date Range

API	Description
GET api/v2/Estimate/GetEstimateList?companyId={companyId}&fromdate={fromdate}&todate={todate}	Get Estimate List
GET api/v2/Estimate/GetEstimateListByScheduledate?companyId={companyId}&fromdate={fromdate}&todate={todate}	Get estimate list by scheduledate
GET api/v2/Estimate/GetEstimateListByReceivedDate?companyId={companyId}&fromdate={fromdate}&todate={todate}	Get estimate list by Received Date

API	Description
POST api/v1/AvidTrack/PostInsertAvidTrack	Insert a new record on tavidtrackinfo and uptade estimate

API	Description
POST api/v1/Estimate/PostCreateEstimate	Create Estimate
POST api/v1/Estimate/EstimateConversionRate?fromdate={fromdate}&todate={todate}&companyid={companyid}	Conversion Rate
POST api/v1/Estimate/EstimateTotalAndCompleteJobs?fromdate={fromdate}&todate={todate}&companyid={companyid}	Total number of estimates and completed jobs
POST api/v1/Estimate/EstimateTotalAndNotCompleteJobs?fromdate={fromdate}&todate={todate}&companyid={companyid}	Total number of estimates and not completed jobs

API	Description
GET api/v1/GPS/GetAlarms?companyid={companyid}&fromdate={fromdate}&todate={todate}	Get Alarms (SpeedLimit, SeatBelt, LeavingGeofence,HardBreaking, HardAcceleration,SharpTurn,IdleTime)
GET api/v1/GPS/GetDriverBehavior?companyid={companyid}&fromdate={fromdate}&todate={todate}&vehicle={vehicle}&branchid={branchid}	Get driver behaviour by date range
GET api/v1/GPS/GetDriverBehaviorByDays?companyid={companyid}&fromdate={fromdate}&todate={todate}&vehicle={vehicle}&branchid={branchid}	Get driver behaviour by days

API	Description
GET api/v1/Thermacell/EndPointTest?stringTest={stringTest}	Endpoint for termacell test

API	Description
GET api/v1/Setup/GetCompaniesList	Get List Of All Companies Information
GET api/v1/Setup/GetCompanyByCompanyId?companyid={companyid}	Get Company Info By Company Id
GET api/v1/Setup/GetBranchesList?page={page}&pagelimit={pagelimit}	Get List Of All Branches Information
GET api/v1/Setup/GetBranchesByPostlCode?companyId={companyId}&postalCode={postalCode}	Get List Of All Branches by Postal Code
GET api/v1/Setup/GetBranchesListInCompanyByCompanyId?companyid={companyid}&page={page}&pagelimit={pagelimit}	Get Branches Info Inside Company By Company Id
GET api/v1/Setup/GetBranchByBranchId?branchid={branchid}	Get Branch Info By Branch Id
GET api/v1/Setup/GetInventoryItemList?page={page}	Get List Of All Inventory Item Information
GET api/v1/Setup/GetInventoryItemByItemId?itemid={itemid}	Get Inventory Item Info By Item Id
GET api/v1/Setup/GetEstimateList?page={page}	Get List Of All Estimates Information
GET api/v1/Setup/GetEstimateByEstimateTypeId?estimatetypeid={estimatetypeid}	Get EstimateType Info By EstimateType Id
GET api/v1/Setup/GetEventList?page={page}	Get List Of All Events Information
GET api/v1/Setup/GetEventByEventTypeId?eventtypeid={eventtypeid}	Get Event Info By EventType Id
GET api/v1/Setup/GetEventByCompany?companyid={companyid}&languageid={languageid}&page={page}&pagelimit={pagelimit}	Get Event List By Company Id
GET api/v1/Setup/GetRouteList	Get List Of All Route Information
GET api/v1/Setup/GetRouteListByBranchId?branchid={branchid}	Get List Of All Route Information By BranchId
GET api/v1/Setup/GetRouteByRouteId?routeid={routeid}	Get Route Info By Route Id
GET api/v1/Setup/GetEmployeeList	Get List Of All Employee Information
GET api/v1/Setup/GetEmployeeListByBranchId?branchid={branchid}	Get List Of All Employee Information By BranchId
GET api/v1/Setup/GetEmployeeByEmployeeId?employeeid={employeeid}	Get Employee Info By Employee Id
GET api/v1/Setup/GetTargetCategoryList?page={page}	Get List Of All Target Category Info
GET api/v1/Setup/GetTargetCategoryByTargetCategoryId?targetcategoryid={targetcategoryid}	Get Target Category Info By Target Category Id
GET api/v1/Setup/GetTargetList?page={page}	Get List Of All Target Info
GET api/v1/Setup/GetTargetByTargetTypeId?targettypeid={targettypeid}	Get Target Info By Target Type Id
GET api/v1/Setup/GetTargetCategoryLinkByTargetTypeId?targettypeid={targettypeid}	Get Target Category Link Info By Target Type Id
GET api/v1/Setup/GetProgramList?page={page}	Get List Of All Program Info
GET api/v1/Setup/GetProgramByProgramTypeId?programtypeid={programtypeid}	Get Program Info By Program Type Id
GET api/v1/Setup/GetProgramEventListByProgramTypeId?programtypeid={programtypeid}	Get List Of Program Event By Program Type Id
GET api/v1/Setup/GetProgramInventoryItemListByProgramTypeId?programtypeid={programtypeid}	Get List Of Program Inventory Item By Program Type Id
GET api/v1/Setup/GetProgramBranchByProgramTypeId?programtypeid={programtypeid}	Get List Of Program Branch By Program Type Id

Get Route Info By Route Id

Method: GET api/v1/Setup/GetRouteByRouteId?routeid={routeid}

Response Format:

application/json

Required Parameters	Description	Additional information
routeid	Route Id	Define this parameter in the request URI.

application/json, text/json

Sample Response:

                        {
  "routeid": 1,
  "routename": "sample string 2",
  "isactive": 3,
  "companyid": 4,
  "utctimestamp": "2025-02-23T06:36:16.3121358+00:00",
  "lastchanged": "2025-02-23T06:36:16.3121358+00:00",
  "lastchangedby": "sample string 5",
  "createdby": "sample string 6",
  "defaultemployeeid": 7,
  "mapdrivercostunit": 8,
  "mapendaddress": "sample string 9",
  "mapendcity": "sample string 10",
  "mapendstate": "sample string 11",
  "mapendtime": 12,
  "mapendtitle": "sample string 13",
  "mapendzip": "sample string 14",
  "mapfuelconsumptioncity": 15,
  "mapfuelconsumptionhwy": 16,
  "mapfuelconsumptionunit": 17,
  "mapfuelcost": 18.0,
  "mapfueltankcapacity": 19,
  "mapfueltankunits": 20,
  "mapspeedarterial": 21,
  "mapspeedinterstate": 22,
  "mapspeedlimitedhwy": 23,
  "mapspeedotherhwy": 24,
  "mapspeedstreet": 25,
  "mapstartaddress": "sample string 26",
  "mapstartcity": "sample string 27",
  "mapstartstate": "sample string 28",
  "mapstarttime": 29,
  "mapstarttitle": "sample string 30",
  "mapstartzip": "sample string 31",
  "isnotify": 32,
  "startaddressid": 33,
  "endaddressid": 34,
  "country": 35,
  "vieworder": 36
};

Home / API Documentation

ServicePro API Documentation

Introduction

AccountController

ContactLogController

EmployeesController

EventController

InventoryController

ProgramController

TokenController

InvoiceController

WorkOrderController

EstimateController

AvidTrackController

EstimateController

GPSController

ThermacellController

SetupController

Get Route Info By Route Id

Method: GET api/v1/Setup/GetRouteByRouteId?routeid={routeid}

application/json, text/json