Advanced

API Reference

Overview

FreshStay provides a RESTful API secured with Laravel Sanctum for building mobile apps or integrating with external services.

All API requests require a Bearer token. Obtain a token via the login endpoint:

BASH

POST /api/v1/auth/login
Content-Type: application/json

{
    "email": "user@example.com",
    "password": "your_password"
}

Response:

JSON

{
    "token": "1|abc123...",
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "user@example.com"
    }
}

Use the token in subsequent requests:

BASH

Authorization: Bearer 1|abc123...

Method	Endpoint	Description
GET	`/api/v1/properties`	List properties with filters
GET	`/api/v1/properties/{id}`	Get property details
POST	`/api/v1/properties`	Create a new property
PUT	`/api/v1/properties/{id}`	Update a property
DELETE	`/api/v1/properties/{id}`	Delete a property

**Note:** Rate limiting is set to 60 requests per minute per user. Contact support if you need a higher limit.

The API returns standard HTTP status codes:

**Tip:** All validation errors return a `422` status with a JSON body containing field-specific error messages.

Was this page helpful?

On this page