Homebase API Access - Common FAQs

Homebase offers read-only API Access on the All in One plan (in most cases) to customers who want the API to enable building integrations for a wide range of use cases.

Note: API access should not be suggested to customers unless specifically requested and after confirming the account details & request by reviewing the information provided below.

---

What does API mean?

The term API is an acronym, and it stands for Application Programming Interface.

There are two types of API Access— Read and Read/Write.

• Read— Allows to pull data out
• Read/Write—Allows to pull data out and allows pulling data in

Homebase offers a read-only API key, which allows customers to retrieve data from our system.

Note: Currently, Homebase does not offer training on how to use the API, so you’d already need to be familiar with it in order to utilize our API key.

---

Can I edit any data using the Homebase API?

Currently, we only offer read-only access to our API key. This means that information cannot be added to Homebase or changed within Homebase via our API. Instead, you’d only be able to retrieve data that already exists regarding your account.

---

Can I use my API access to connect with other types of software?

Unless your POS or Payroll Partner offers a custom integration using API, we do not recommend using the API in an attempt to integrate another system. Please confirm with this partner, as they’d need to allow a custom integration in order for our API to be used to integrate.

We do NOT recommend that customers purchase API in an attempt to integrate two systems that do not integrate together. It's not a workaround for direct integration. We should never suggest APIs for this reason.

---

How can I get an API key?

Note: API access is only available to customers with the All in One plan.

1. Sign into your Homebase account and upgrade to the All in One plan (if applicable).
2. Click Settings on the left side of your screen.
3. Click API Access.
4. Click Request API Key.

The team will review the request, usually within 1 business day.

---

Where can the API Key and Location UUIDs be retrieved after approval?

1. Sign into your Homebase account (Owner's Account).
2. Click Settings on the left side of your screen.
3. Click API Access.

---