This article walks you through the basics of accessing the HappyCo API for the first time. For a deeper dive, see the HappyCo API Tutorial.

The API endpoint

All requests are made to a single endpoint:

Step 1: Authenticate

The HappyCo user you authenticate with must be an Administrator and cannot be an SSO user. If your organization uses SSO, you'll need to first create a dedicated API user:

1. Go to your HappyCo Admin Center and create a new user
2. Set their role to Administrator
3. Set a password for that user directly in HappyCo — this is the password you'll use in the Login mutation

Once you have valid credentials, log in via the login mutation. This returns a session token you'll include in subsequent requests. You can run this directly in the HappyCo GraphQL Schema & Explorer.

Step 2: Explore the schema

The HappyCo GraphQL Schema & Explorer is an interactive tool where you can browse every available query and mutation and run test calls against your account directly in the browser. Pre-written example queries are available via the bookmark icon in the top left — start there to get a feel for the API before writing your own.

Step 3: Go deeper

The HappyCo API Tutorial walks through authentication in more detail, pagination, webhooks, and other special topics to help you build out your integration.