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

# Welcome to Open Referral

Open Referral is a B2B SaaS to run and scale employee referral programs. This documentation will walk you through setting up your account, connecting your ATS, and piloting your program in natural language from your favourite AI assistant.

{% hint style="info" %}
🚧 This documentation is being written. Pages are scaffolded and will be filled in progressively.
{% endhint %}

### Where to go next

* **Getting started** — create your account and launch your first program.
* **Knowledge** — core concepts and best practices.
* **ATS integrations** — connect your Applicant Tracking System (scrapers, entities, synchronisation).
* **AI assistant integrations** — use Open Referral from Claude, Gemini CLI, ChatGPT or Le Chat.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openreferral.io/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.