Garage Hive API Permission Sets

Garage Hive API Permission Sets

Article Status Update: This article is new and is currently under review. Please check back later.
Permission sets are how you control what an application can see and do in Business Central. Microsoft Entra ID decides whether an application is allowed to ask for a token at all. Permission sets decide what it can actually reach once it has one.
This article lists the Garage Hive permission sets, what each one covers, and which to assign for a given integration.
Give an application only what it needs. An application that reads customer records should not also be able to reach jobsheets, employees or financial data. Assigning broad access is convenient, and it means any mistake or compromise in that application reaches your whole system rather than one corner of it. Start narrow and widen only when something genuinely does not work.

The Garage Hive permission sets

Search for Permission Sets in Business Central and filter on GHV to see these.
Permission set
Name
What it is for
GHV GARAGELINK API
GHV GarageLink API Access
The main API permission set. Covers customers and contacts, vehicles, makes and models, service documents such as jobsheets, estimates and inspections, their lines, groups and comments, labour, service packages, checklists, branches, media and pricing.
GHV PHONEBOOK API
GHV Phonebook API Read Access
Contacts and customer ranking data, used for caller identification and customer lookup. Small, tightly scoped, and read-only throughout.
GHV PHONE LOG API
GHV Phone Comm. Log API
Communication log entries and the customer, vehicle and service document records they relate to. Read-only throughout.
GHV SERVICESPLIT API
GHV SERVICESPLIT API
Service splitting, covering service headers, service comment lines and the ServiceSplit integration setup. The only API permission set that includes write access.
GHV GH FULL ACCESS
GH Full Access
Full read and write access across Garage Hive. Broad by design. See the warning below before assigning it.
GHVUK FULL ACCESS
GHVUK FULL ACCESS
Full access to the Garage Hive UK Features extension. Assigned alongside GH Full Access where UK-specific functionality is in use.
GHV TECH
GHV Technician
A broad role for technician users, covering around 270 tables with extensive read and write access. Not intended for API integrations.

GHV GARAGELINK API

The largest of the API sets, at 80 table permissions.
Direct read on Customer, Contact, Contact Business Relation, Dimension Value, Dimension Set Entry, General Ledger Setup, Price List Line, Price Calculation Setup, Dataverse Connection Setup, GHV Service Management Setup, GHV Vehicle Contact and GHV Self-Service Change Log Setup.
Indirect permissions cover the bulk of Garage Hive's operational data: Vehicle, Make, Model, Service Header, Service Line, Service Line Group, Service Comment Line, Service Labour and its groups, Service Package with its versions and version lines, Process Checklist headers, lines and items, Checklist Templates, Branch, Media, Customer Category, Item Price Group, Communication Log Entry, Customer Notification and GarageLink Setup.
No insert, modify or delete permissions are included, apart from delete on GHV Vehicle Contact.

GHV PHONEBOOK API

Seven tables: Company Information, Contact, Contact Business Relation, Marketing Setup, GHV Customer Survey Answer Entry, GHV Customer Rank Entry and User.
No insert, modify or delete permissions are included anywhere in this set.

GHV PHONE LOG API

Five tables: Customer, GHV Communication Log Entry, GHV Notification Source Code, GHV Service Header and GHV Vehicle.
No insert, modify or delete permissions are included anywhere in this set.

GHV SERVICESPLIT API

Fourteen tables, all with direct read: User Setup, General Ledger Setup, Change Log Setup with its table and field variants, Change Log Entry, Dataverse Connection Setup, GHV Service Header, GHV Service Comment Line, GHV Service Comment Line Type, GHV Service Management Setup, GHV ServiceSplit Integration Setup, GHV Self-Service Change Log Setup and User.
This is the only API permission set that grants write access: insert on Change Log Entry, and insert and modify on GHV Service Comment Line.

Working combinations

The applications below are configured this way in a live Garage Hive environment. They are a useful starting point, because they show combinations that are known to work rather than combinations that ought to.
Application
Permission sets assigned
Caller identification only
GHV PHONEBOOK API
GarageLink
GHV GARAGELINK API and GHV PHONEBOOK API
Garage Hive service application
D365 BUS FULL ACCESS, GHV GH FULL ACCESS and GHVUK FULL ACCESS
Note the second row. GarageLink is assigned the Phonebook permission set as well as the GarageLink one. If an integration covers more than one area, it usually needs more than one permission set. Assigning several narrow sets is the correct approach, and is better than reaching for a single broad one.

Choosing permission sets

    Work out what the integration actually touches. List the data it needs to read, and separately the data it needs to change. Most integrations read far more than they write.
    Assign the matching permission set or sets from the table above.
    Test. If a request returns nothing, the cause is usually a missing permission set rather than a wrong URL.
    Review it later. Requirements change and permissions rarely get tightened afterwards unless someone makes a point of it.
Note: An application cannot be assigned the SUPER permission set. Business Central prevents it deliberately.


Need Help?

If you are unsure which permission sets an integration requires, contact  Garage Hive support  with the list of endpoints the application will use.


See Also




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