# HirePOS API Documentation

This is the complete API documentation for connecting to the HirePOS API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **HirePOS connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/hirePOS/actions/{actionSlug}/run
```

## HirePOS actions

- GET `authenticate` Authenticate
- POST `create-customer` Create Customer
- POST `create-lead` Create Lead
- POST `create-website-booking` Create Website Booking
- GET `get-availability` Get Availability
- GET `get-delivery-pickup-status` Get Delivery Pickup Status
- GET `get-last-website-order` Get Last Website Order
- GET `get-package` Get Package
- GET `get-website-booking` Get Website Booking
- GET `list-dispatched-today` List Dispatched Today
- GET `list-items` List Items
- GET `list-returned-today` List Returned Today
- GET `list-sales-stock-levels` List Sales Stock Levels
