Skip to main content
This article gets a bit technical. If you already know what an API is and want to see what Garde offers, skip ahead. If not, read on — we’ll start with the basics.
Who is this for? The Garde Public API is designed for developers building custom integrations. If you or someone on your team has a technical background and wants to pull data out of Garde into another system, this is the right starting point. Most day-to-day Garde users won’t need the API.
The API is a good fit if:
  • You use a third-party platform that has built (or plans to build) an integration with the Garde Public API.
  • You or your team have the technical skills to build a custom integration with Garde.
Think one of those applies? Let’s dig in.

​
What is a Public API?

API stands for Application Programming Interface. Software applications use APIs to talk to each other — passing data one way or back and forth. This is how most software “integrations” work under the hood. A public API is one that’s openly documented so outside developers can build against it.

​
Wait, does “public” mean anyone can see my restaurant’s data?

Not at all. “Public” just means the interface itself is documented and available to use. Think of it like the front door to your house — anyone can see the door, but only someone with a key can get in. The Garde API works the same way: only users authorized by a restaurant can access that restaurant’s data.

​
What does the Garde Public API support?

The API is read-only. Data flows one way: from Garde out to an external application. You cannot use the API to create or update data in Garde. The API can send:

  • ​
    Raw invoice data

  • ​
    Product data

  • ​
    Categories

  • ​
    Vendors

  • ​
    Vendor items

  • ​
    Restaurant unit groups

  • ​
    Restaurant unit group categories

Not every field for each data type is available. The full details are in the API documentation, which you can access through the Garde developer portal inside your Garde account.

​
How do I build an integration?

You’ll need someone with development experience. The Garde developer portal (accessible from within your Garde account) has the full API documentation, including endpoints, authentication, and data schemas — everything a developer needs to get started.

​
Is there an extra cost?

No. The Garde Public API is included with any Garde subscription. That said, if you’re not uploading invoices or creating products in Garde, the API won’t have any data to return — since that’s exactly the data it exposes.

​
Can the API replace a POS or accounting system integration?

No. Here’s why:
  • POS integrations send data into Garde from the POS. The public API only sends data out of Garde. It can’t read data from external systems like a POS.
  • Accounting integrations (Garde supports QuickBooks Online and QuickBooks Desktop) involve a two-way data flow between Garde and the accounting system. Garde imports vendors, chart of accounts, and other data to establish mappings, then tracks which transactions have been posted. The public API can’t replicate any of that. It also doesn’t support inventory data or daily sales entries that are typically exported to accounting.