Authentication

The Shop Boss API secures requests through the use of API keys. To initiate the authentication process and gain access to our API, follow the outlined steps:

1. Request an API key by contacting our support team via email at support@shopbosspro.com. Include any relevant information about your application and the data you wish to access.

2. Upon reviewing your request, our team will provide you with an API key. This key is essential for authenticating your requests to the Shop Boss API .

3. Include this API key in the header of each API request. The key will remain active unless it is explicitly revoked. Should there be any changes in your access requirements, either an expansion or a restriction, the same API key will continue to function. Adjustments to your access level will be handled by our support team without the need for a new key.

PermissionsCopied!

By default, each API key gets access to a defined set of permissions, these permissions determine to which endpoints you get access to. When requesting the API key, make sure to note which endpoints you’ll want to get access and say so in the email to support.

Note: If you’re not sure or if you already have an API key and you noticed you want access to something you currently don’t have, you can also request access to those endpoints later, so you won’t need to request a new API key for the missing endpoints if necessary.

Existing Permissions:

[ ] Appointments
[ ] Canned Jobs
[ ] Complaints
[ ] Cores
[ ] Customers
[ ] Inspections
[ ] Employees
[ ] Jobs
[ ] Parts
[ ] Part Details
[ ] Part Sales
[ ] Repair Orders
[ ] Recommended Repairs
[ ] Vehicles
[ ] Quotes
[ ] Parts Inventory

And the default set of permissions given to an API key are the following:

[x] Appointments
[ ] Canned Jobs
[ ] Complaints
[ ] Cores
[X] Customers
[ ] Inspections
[X] Employees
[ ] Jobs
[ ] Parts
[ ] Part Details
[ ] Part Sales
[X] Repair Orders
[ ] Recommended Repairs
[X] Vehicles
[ ] Quotes
[ ] Parts Inventory