Introduction

The GraphQL Admin API lets you build apps and other integrations for the Endear platform using GraphQL.

Before you get setup

Endear's Admin API, today, is primarily built to sync external data into Endear. As a result, each unique data source that you wish to sync should use it's own Integration & API key within Endear. THIS IS VERY IMPORTANT. If you send two different records with the same ID to the same integration, it will overwrite the previous record. Therefore, it is best to silo your data sources by integration.

How to create an integration & API key

  1. Visit your Endear settings
  2. Click Integrations
  3. Click Add Integration
  4. Choose API
  5. Fill in the details, and get your API key

How to access & authenticate the API

Once you've generated an API key, you can access the API via a POST request to https://api.endearhq.com/graphql. You'll need to include the header: X-Endear-Api-Key with the value of your generated API key to authenticate. It's important to understand that each API key is scoped to a specific brand. Therefore, you'll need to acquire a separate API key for each brand.