Garage Hive API Endpoints

Garage Hive API Endpoints

These API endpoints are built by Garage Hive. They give access to garage-specific data that is not available through the standard Microsoft Business Central APIs. This article lists every API published by Garage Hive (publisher garageHive), grouped by module. Some endpoints are available to all Garage Hive users. Others are included in the  Garage Link Advanced  module and are currently in beta.

Important: Replace {{tenantId}} with the client's Microsoft Entra ID tenant ID, and replace {{environmentName}} with the name of the client's Business Central environment (e.g. Production, Sandbox). The environment name is set by the customer and may vary. Common names include Production, Prod, and Sandbox.

Getting Available Endpoints

To see the available entities for a Garage Hive API module, send a GET request to the module's base URL. The response returns a JSON directory of all entities in that module.
General API (Read-Only, v2.0)
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/general/v2.0
Service API (v2.0)
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/service/v2.0
Phone Integration API (v2.0)
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/phoneIntegration/v2.0
Autodata API (v2.0)
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/autodata/v2.0
Power BI / Locations API (v3.0)
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/powerBI/v3.0


General API (v2.0)

Read-only access to core Garage Hive records. Available to all users regardless of plan. Used for reporting and data extraction, for example Power BI.
Base URL
https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/general/v2.0
Entity (BC)
Endpoint path
Description
customer
customers
Garage Hive customer records with garage-specific fields
vehicle
vehicles
Vehicle records including registration, make, model, and VIN
make
makes
Vehicle manufacturer (make) definitions
model
models
Vehicle model definitions linked to makes
labour
labours
Labour records used to define standard labour operations
customerTemplate
customertemplate
Customer templates used to apply default settings when creating customers

Service API (v2.0)

Read-write access to workshop operation data such as jobsheets, estimates, inspections, and service packages. Included in the  Garage Link Advanced  module. Currently in beta.
Base URL
https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/service/v2.0
Entity (BC)
Endpoint path
Description
jobsheet
jobsheets
Jobsheet header records including status, customer, and vehicle
jobsheetLine
jobsheetLines
Individual line items on a jobsheet, such as parts and labour
jobsheetGroup
jobsheetGroups
Group Items on jobsheets, used to categorise jobsheet lines by job
estimate
estimate
Estimate header records for quoted work
estimateLine
estimateline
Individual line items on an estimate, such as parts and labour
estimateGroup
estimateGroups
Group Items on estimates, used to categorise estimate lines by job
serviceComment
servicecomment
Comments recorded against service documents such as jobsheets and estimates
vehicleInspectionEstimate
vehicleInspectionEstimate
Vehicle Inspection Estimate (VIE) header records
vehicleInspectionEstimateLine
vehicleInspectionEstimateLine
Line items on a Vehicle Inspection Estimate
vehicleInspectionEstimateGroup
vieGroups
Group Items on Vehicle Inspection Estimates, used to categorise inspection lines
servicePackage
servicePackage
Service package definitions (bundled service offerings)
servicePackageVersion
servicePackageVersion
Versions of a service package
servicePackageVersionLine
servicePackageVersionLine
Line items within a service package version

Phone Integration API (v2.0)

Powers caller identification in Garage Hive, matching incoming calls to customer records. Read-only, available to all users.
Base URL
https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/phoneIntegration/v2.0
Entity (BC)
Endpoint path
Description
gH1Phonebook
gH1PhonebookList
Phonebook records for caller identification and customer lookup
Sample Request
GET https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/phoneIntegration/v2.0/gH1PhonebookList
Sample Response
{
  "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/phoneIntegration/v2.0/$metadata#gH1PhonebookList",
  "value": [
    {
      "recId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "contactNo": "C-000123",
      "customerNo": "CU-1001",
      "name": "John Smith",
      "phoneNo": "+44 20 7946 0123",
      "phoneNo2": "+44 19 8765 4321",
      "mobilePhoneNo": "+44 71 2345 6789",
      "mobilePhoneNo2": "+44 79 8765 4321",
      "contactNotes": "Prefers calls after 15:00.",
      "rankCode": "GOLD",
      "rankComment": "High-value customer, frequent services.",
      "npsValue": "9",
      "url": "https://businesscentral.dynamics.com/?tenant={{tenantId}}&company=Garage%20Hive&page=GHV%20Phonebook%20Contact%20Card",
      "systemCreatedAt": "2022-04-12T09:23:45Z",
      "systemModifiedAt": "2024-07-28T14:11:02Z"
    }
  ]
}

Autodata API (v2.0)

Exposes Autodata repair-time data used in Garage Hive. Included in the  Garage Link Advanced  module.
Base URL
https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/autodata/v2.0
Entity (BC)
Endpoint path
Description
autodataRepairTime
autodataRepairTimes
Autodata repair-time (labour time) records for repair operations
autodataRepairTimeLookup
autodataRepairTimeLookups
Lookup records used to find Autodata repair times
autodataRepairTimeType
autodataRepairTimeTypes
Autodata repair-time type and category definitions
autodataRepairTimePart
autodataRepairTimeParts
Parts associated with Autodata repair times

Repair Times workflow

The Autodata repair-time lookup is a multi-step OData v4 flow. Paths below are relative to the Autodata base URL above.
POST   autodataRepairTimeLookups
GET    autodataRepairTimeTypes?$filter=lookupSystemId eq {lookupId}&$orderby=entryNo
POST   autodataRepairTimeLookups({lookupId})/Microsoft.NAV.fetchRepairTimeLines
GET    autodataRepairTimes?$filter=lookupSystemId eq {lookupId} and repairTimesId eq '{repairTimesId}'&$orderby=entryNo
GET    autodataRepairTimeParts?$filter=lookupSystemId eq {lookupId} and repairTimesId eq '{repairTimesId}'&$orderby=lineEntryNo
Bound actions
POST   vehicles({vehicleId})/Microsoft.NAV.initAutodataRepairTimes
DELETE autodataRepairTimeLookups({lookupId})
Microsoft.NAV.initAutodataRepairTimes sits on the General module vehicles endpoint. It creates a lookup from the vehicle registration, so an external system can start the flow from an existing Vehicle record.

Power BI / Locations API (v3.0)

Location records exposed for Power BI reporting across multi-location setups. This module uses API version v3.0.
Base URL
https://api.businesscentral.dynamics.com/v2.0/{{tenantId}}/{{environmentName}}/api/garageHive/powerBI/v3.0
Entity (BC)
Endpoint path
Description
gh1location
gh1location
Location records exposed for Power BI reporting (multi-location setups)
The  Online Booking API  is also included in the Garage Link Advanced module and is currently in beta. See its dedicated article for the full endpoint documentation.


See Also



Globe with Meridians English (UK, IE, IM and IZ). To find documentation in other regions where Garage Hive operates, click  here.