> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/getting-started.md).

# Welcome to Open Loyalty!

Everything you need to run, build and grow a loyalty program on Open Loyalty — from your first campaign in the Admin Panel to a full API integration.

**Open Loyalty is a headless, API-first loyalty platform.** Run points, tiers, campaigns, challenges and rewards from one engine, connect it to any channel through the REST API, and manage the whole program in the Admin Panel — no custom code needed for the day-to-day.

These docs cover the whole journey: running the program day to day, planning an implementation, and integrating with the API.

***

## 🧭 Find your way

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>User Guide</strong></td><td>Run your loyalty program in the Admin Panel: members, campaigns, rewards, tiers and analytics, step by step.</td><td>For loyalty and marketing teams</td><td><a href="/getting-started-1/dashboard.md">Dashboard</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-9f9d3cacd458daa70c1b75539d86117f8f512bd5%2Fhome-user-guide.jpg?alt=media">home-user-guide.jpg</a></td></tr><tr><td><strong>Implementation Guide</strong></td><td>Plan, integrate and launch a program: decisions, module checklists, data migration and go-live.</td><td>For solution architects and project teams</td><td><a href="https://help.openloyalty.io/implementation-guide">https://help.openloyalty.io/implementation-guide</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-8330fef0d3ac816ea97a37b543e2800fd6007b27%2Fhome-implementation-guide.jpg?alt=media">home-implementation-guide.jpg</a></td></tr><tr><td><strong>Developer Guide</strong></td><td>Integrate with Open Loyalty: authentication, API fundamentals, webhooks, data exports and integration examples.</td><td>For developers</td><td><a href="https://help.openloyalty.io/technical-guide">https://help.openloyalty.io/technical-guide</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-a96dc97b681393716ae1f5f3ed2f2148cc6cc19e%2Fhome-developer-guide.jpg?alt=media">home-developer-guide.jpg</a></td></tr><tr><td><strong>API Reference</strong></td><td>Every endpoint with its parameters, request and response examples.</td><td>For developers</td><td><a href="https://help.openloyalty.io/api-reference">https://help.openloyalty.io/api-reference</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-94db928bfb52b3e377ba7d53c45dacd84773ccfd%2Fhome-api-reference.jpg?alt=media">home-api-reference.jpg</a></td></tr></tbody></table>

***

## 🚀 Popular starting points

* [**Create a campaign**](/campaigns/campaigns/campaigns-and-referral-campaigns/creating-campaigns.md) — reward purchases, events and milestones.
* [**Set up tiers**](/gamification/tiers.md) — give members a status worth climbing.
* [**Build segments**](/members-and-activity/members/segments.md) — group members for targeting, live as their data changes.
* [**Add rewards**](/rewards-redemption/rewards.md) — coupons, physical rewards and more for members to redeem.
* [**Upload your product catalog**](/integrations-and-data-exchange/product-catalog.md) — reward individual products and see how each one performs.
* [**Test before you launch**](/campaigns/campaigns/campaign-simulation.md) — simulate a purchase and see which campaigns apply.

***

## 📚 Learn and keep up

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Playbook</strong></td><td>Good practices and sample setups for campaigns, challenges and member engagement.</td><td><a href="https://help.openloyalty.io/playbook">https://help.openloyalty.io/playbook</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-fdb979117a17eee5db1b7e1463be53ee3d875d10%2Fhome-playbook.jpg?alt=media">home-playbook.jpg</a></td></tr><tr><td><strong>What's New</strong></td><td>The latest features and improvements, month by month.</td><td><a href="/whats-new.md">What's New</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-5fb4aef95903066180cba1702b98d981180003f0%2Fhome-whats-new.jpg?alt=media">home-whats-new.jpg</a></td></tr><tr><td><strong>What's Next</strong></td><td>What we're working on now, next and later.</td><td><a href="/whats-next.md">What's Next</a></td><td><a href="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fgit-blob-a3b31524d7305b5f19ebb32c7595a70fd8ea1d07%2Fhome-whats-next.jpg?alt=media">home-whats-next.jpg</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.openloyalty.io/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.