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

# API Access

Configure and use the Kenekt API to integrate with external systems.

## API Endpoints

The Kenekt API provides access to:

| Endpoint | Description |
| - | - |
| `/api/v1/properties` | List and manage packages |
| `/api/v1/deals` | Create and track deals |
| `/api/v1/contacts` | Manage contact records |
| `/api/v1/webhooks` | Configure webhook subscriptions |

## Authentication

All API requests require authentication via API key:

```
Authorization: Bearer YOUR_API_KEY
```

Or as a query parameter:

```
https://app.kenekt.com.au/api/v1/properties?api_key=YOUR_API_KEY
```

## Rate Limits

To ensure fair usage:

* **Standard:** 100 requests per minute
* **Bulk operations:** 10 requests per minute
* **Rate limit headers** included in responses

## Response Format

All responses are JSON:

```json theme={null}
{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 25
  }
}
```

## Common Operations

### List Properties

```
GET /api/v1/properties
```

Parameters:

* `status`: Filter by status (available, sold, etc.)
* `project_id`: Filter by project
* `page`: Page number
* `per_page`: Results per page

### Get Property Details

```
GET /api/v1/properties/:public_uid
```

### Create a Deal

```
POST /api/v1/deals
```

Required fields:

* `build_id`: Package ID
* `deal_type`: Type of deal (enquiry, hold, etc.)

## Error Handling

| Status Code | Meaning |
| - | - |
| 200 | Success |
| 401 | Invalid or missing API key |
| 403 | Insufficient permissions |
| 404 | Resource not found |
| 429 | Rate limit exceeded |
| 500 | Server error |

## Tips

* Use pagination for large result sets
* Cache responses where appropriate
* Handle rate limits gracefully with retries
* Check the API documentation for full endpoint details


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