Authentication

Learn how to authenticate requests to Endear's API endpoints.

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.

curl https://api.endearhq.com/graphql \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-Endear-Api-Key: {{API_KEY}}" \
  -d '{"query":"query { currentIntegration{ id } }"}'

What’s Next