The HappyCo External API is a GraphQL API, allowing you to make deeply-nested or shallow queries to get as much or as little data as you need for any scenario.

The endpoint for all API calls is https://externalgraph.happyco.com

Quick Start

You can explore the API schema and practice making queries using the API explorer.

**Here is a short video** to show you around the API explorer with some tips on how to use it efficiently. And here is a shorter video showing a more surgical strike at how to get the graph to show you the location of an inspection.

Plugin Partners

To log into the API as a plugin partner you must have a plugin ID and client secret, which are unique to each one of your Plugins (Follow these instructions to generate your credentials if you haven’t done so already)

1. Open the Plugin Queries collection and click into the PluginLogin query.
2. Open the Plugin Queries collection and click into the CurrentPlugin query.

Customers

To log in as a customer you must have user credentials to log into HappyCo’s web application. The same credentials will work for your API login.

1. Open the Customer Queries collection and click into the CustomerLogin query.
2. Open the Shared Queries collection and click into the Properties query.

Tutorial

There are two ways to sign into the API — as a customer, or as a plugin partner. Each kind of client has some API calls that the other can’t make, but most API calls are available to both. The main difference is how you log in and which data are available to you.