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

# Tools

> One tool per API endpoint, with the same filters and scopes. An assistant only sees the tools its key can use.

| Tool | Scope | What it does |
| - | - | - |
| `get_key` | None | This key's name, scopes and expiry date. |
| `get_brand` | None | The brand this key belongs to. |
| `search_businesses` | `businesses:read` | Search and filter businesses. |
| `get_business` | `businesses:read` | One business, with its contacts and deals if asked. |
| `list_business_groups` | `businesses:read` | Your business groups. |
| `list_opportunities` | `opportunities:read` | Deals by pipeline, stage or owner. |
| `list_pipelines` | `opportunities:read` | Pipelines and their stages. |
| `search_orders` | `orders:read` | Orders by date, status or business. |
| `get_order` | `orders:read` | One order with its line items. |
| `list_campaigns` | `campaigns:read` | Campaigns and their headline stats. |
| `get_campaign_report` | `campaigns:read` | One campaign's steps and stats. |
| `list_campaign_recipients` | `campaigns:read` | Who a campaign reached and what they did. |
| `send_feedback` | None | Tell the Overjoy team what's missing or broken. |

## Example questions

* "Which stores in Texas haven't ordered since summer?"
* "What shipped late this week?"
* "How did the fall reorder campaign do?"
* "Which deals in the wholesale pipeline haven't moved in a month?"


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