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

# API Reference

> Complete reference for all UnicyFalcon API endpoints

## Base URL

```
https://{subdomain}.unicyfalcon.com/api/v1
```

Replace `{subdomain}` with your organization's subdomain.

## Authentication

All endpoints require HMAC-SHA256 authentication. See [Authentication Guide](/authentication) for details.

## Available Resources

<CardGroup cols={2}>
  <Card title="Customers" icon="users" href="/api-reference/customers/list">
    Manage customer data (read-only)
  </Card>

  <Card title="Products" icon="box" href="/api-reference/products/list">
    Access product catalog (read-only)
  </Card>

  <Card title="Orders" icon="cart-shopping" href="/api-reference/orders/list">
    Full CRUD operations for orders
  </Card>

  <Card title="Deliveries" icon="truck" href="/api-reference/deliveries/list">
    Complete delivery management
  </Card>
</CardGroup>

## Response Format

All successful responses follow this format:

```json theme={null}
{
  "success": true,
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  },
  "links": {
    "first": "https://...",
    "last": "https://...",
    "prev": null,
    "next": "https://..."
  }
}
```

## Error Format

Error responses follow this structure:

```json theme={null}
{
  "success": false,
  "error": "error_code",
  "message": "Human-readable error message",
  "details": {
    "field": ["Validation error message"]
  }
}
```

## HTTP Status Codes

| Code | Description                   |
| ---- | ----------------------------- |
| 200  | Success                       |
| 201  | Resource created              |
| 400  | Bad request                   |
| 401  | Unauthorized                  |
| 403  | Forbidden (insufficient plan) |
| 404  | Resource not found            |
| 422  | Validation error              |
| 429  | Rate limit exceeded           |
| 500  | Server error                  |

## Pagination

List endpoints support pagination:

* `per_page` (int): Items per page (default: 15, max: 100)
* `page` (int): Page number (default: 1)

Example:

```
GET /api/v1/customers?per_page=50&page=2
```

## Filtering & Search

Most endpoints support filtering and search parameters. See individual endpoint documentation for details.