Skip to main content
This guide walks you from a dashboard API Key to a working public read.

Prerequisites

  • A LoyaltyDog merchant account and a dashboard API Key.
  • curl or any HTTP client.
Dashboard API Keys today are JWTs (the page was renamed from App Keys). Copy the token once. There is no public issuance API for hashed ld_test_ / ld_live_ secrets. POST /appkeys is dashboard-only and keeps minting JWTs.

1. Set your credentials

Never commit tokens to source control. Use a secrets manager, environment variables, or your CI secret store.

2. List loyalty programs

Public product routes are under /v2, not /api/v2.
A successful call returns a JSON array of program objects. An empty list [] is success with no programs yet. JWT App Keys have implicit full merchant access. A hashed ld_* key needs the loyalty:read scope (otherwise 403). Unscoped identity ping: GET /v2/token.

JavaScript (fetch)

Python (requests)

3. Explore the API

Use the Mintlify API playground (generated from the public OpenAPI) or download the spec.

API reference

Every public endpoint, request, and response.

Authentication

JWT App Keys vs hashed ld_* secrets.

Errors

Envelopes, request_id, and status codes.

Webhooks

React to events in real time.