> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withbenji.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Benji Platform APIs

> [!NOTE]
>
> All API endpoints require authentication using an **API key** via the `x-api-key` header. API keys can be generated through the Benji dashboard.

## Overview

The Benji Platform APIs are REST-based APIs that give you access to trigger campaigns, manage partnerships, retrieve user loyalty data, and interact with reward transactions. All endpoints use the `x-api-key` header for authentication.

## API Base URL

```
https://api-staging.withbenji.com (sandbox)
https://api.withbenji.com (production - available after approval post sandbox integration)
```

## API Categories

> [card] [Partnerships](https://docs.withbenji.com/api-reference/endpoint/partnerships/get.md)
>
> Retrieve partnership details and send trigger events

> [card] [Member API](https://docs.withbenji.com/api-reference/endpoint/users/get.md)
>
> Get user information and link external users

> [card] [Reward API](https://docs.withbenji.com/api-reference/endpoint/transactions/get.md)
>
> Retrieve reward transaction details

> [card] [Campaigns](https://docs.withbenji.com/api-reference/endpoint/campaigns/get)
>
> List and retrieve campaign information

> [card] [Webhooks](https://docs.withbenji.com/api-reference/webhooks/overview.md)
>
> Subscribe to events for real-time updates on users, campaigns, and transactions


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.