> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.rebateright.com.au/llms.txt.
> For full documentation content, see https://docs.rebateright.com.au/llms-full.txt.

# API Reference

Select any endpoint from the sidebar to explore its parameters, request body, response schema, and real examples.

<CardGroup cols={4}>
  <Card title="Try an endpoint" icon="play">
    Open an endpoint, adjust the payload if you need to, then **Send** — the response you see is a real call to the API.
  </Card>

  <Card title="Browse examples" icon="list">
    Each endpoint has real request and response examples saved from our test environment. Use the **dropdown** in the response panel to switch between scenarios.
  </Card>

  <Card title="Copy code" icon="code">
    Use the language selector in the right panel to get a ready-to-use code snippet in your preferred language.
  </Card>

  <Card title="Ask AI" icon="message-bot">
    Use the **Ask AI** button in the search bar to ask plain English questions and get instant answers about endpoints, schemas, and error codes.
  </Card>
</CardGroup>

## Required headers and hosts

Every HTTP request to the API must include your credentials obtained during the first-time setup:

| Header       | Value                         |
| ------------ | ----------------------------- |
| `x-api-key`  | Your API key from RebateRight |
| `x-minor-id` | Your Minor ID                 |

## Finding examples

Open an endpoint → look at the **right-hand panel**:

| Panel section | What you'll find                                             |
| ------------- | ------------------------------------------------------------ |
| Top           | Pre-filled request body with a real sample payload           |
| Bottom        | Response schema with a **dropdown** to switch named examples |

Examples on key endpoints include scenarios like *Success*, *New Medicare Card*, *Incorrect Given Name*, *Ineligible*, and more — covering both happy path and error cases.