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

# API overview

> Connect your business system to Need Alert and send alerts automatically.

The Need Alert API lets your business system do, with no one at the screen, what you do today in the dashboard.

## What it's for

> [card] [Back in stock](https://docs.needalert.app/en/api/use-cases.md)
>
> Your ERP sends the alert when a SKU's stock is positive again.

> [card] [Appointment cancelled](https://docs.needalert.app/en/api/use-cases.md)
>
> Your clinic's booking system notifies the specialty's subscribers when a patient cancels.

> [card] [Items in sync](https://docs.needalert.app/en/api/external-reference.md)
>
> Your online store creates and updates items from its own products.

> [card] [Balance under control](https://docs.needalert.app/en/api/use-cases.md)
>
> Your finance team tracks the credit balance and statement.

## What is available

* **API keys** created by the chain owner in the dashboard, with a name, allowed units, and permissions. The key is shown only once and can be rotated or revoked at any time. See [Authentication](https://docs.needalert.app/en/api/authentication.md).
* **Items:** list, create, edit, and archive, with an [external reference](https://docs.needalert.app/en/api/external-reference.md) so you can use your own system's code (such as the SKU), and get the QR code.
* **Dispatches:** estimate the cost, send now or schedule, track the status, reschedule, and cancel. See [First request](https://docs.needalert.app/en/api/first-request.md).
* **Credits:** check the balance and statement.
* **Idempotency:** the [`Idempotency-Key`](https://docs.needalert.app/en/api/idempotency) header so a retry after a network failure doesn't send the alert twice.

Every dispatch through the API follows the same rules as the dashboard: the cost is calculated first, the balance is checked, and the charge is 1 credit per person notified.

## Where to start

1. Read [Authentication](https://docs.needalert.app/en/api/authentication.md) and create the key in the dashboard.
2. Follow [First request](https://docs.needalert.app/en/api/first-request.md) to your first alert.
3. Look up each endpoint in the **Endpoints** group of this tab, and the general rules in [Conventions](https://docs.needalert.app/en/api/conventions.md).
4. Follow changes in the [Changelog](https://docs.needalert.app/en/api/changelog.md).


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