ProfitFlow
  1. Units
ProfitFlow
  • Authentication
    • Login
      POST
    • Logout
      POST
  • Categories
    • List categories
      GET
    • Get category
      GET
  • Units
    • List available units
      GET
    • Get unit details
      GET
  • Investors
    • List investors
      GET
    • Get investor details
      GET
    • Get investor portfolio
      GET
  • Schemas
    • User
    • Category
    • Error
    • Unit
    • Investor
    • ValidationError
    • Portfolio
    • PaginationLinks
    • PaginationMeta
  1. Units

List available units

GET
/units
Get a paginated list of available investment units.
Only active units with available percentage greater than 0 are returned.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Responses

🟢200
application/json
List of available units
Body

Example
{
    "data": [
        {
            "id": 1,
            "code": "UNIT-0001",
            "slug": "downtown-office-tower",
            "name": "Downtown Office Tower",
            "description": "Premium office space in the heart of downtown",
            "location": "Cairo, Egypt",
            "latitude": 30.0444,
            "longitude": 31.2357,
            "total_value": 5000000,
            "currency": "EGP",
            "available_percentage": 45.5,
            "sold_percentage": 54.5,
            "minimum_investment": 50000,
            "expected_annual_return": 12.5,
            "status": "active",
            "launch_date": "2024-01-01",
            "maturity_date": "2027-01-01",
            "featured_image": "https://example.com/images/unit-1.jpg",
            "gallery_images": [
                "https://example.com/images/unit-1-a.jpg",
                "https://example.com/images/unit-1-b.jpg"
            ],
            "category": {
                "id": 1,
                "name": "Commercial Real Estate",
                "icon": "building",
                "color": "#3B82F6"
            },
            "created_at": "2024-01-15T10:30:00+00:00",
            "updated_at": "2024-01-20T14:45:00+00:00"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v1/categories?page=1",
        "last": "http://localhost:8000/api/v1/categories?page=3",
        "prev": null,
        "next": "http://localhost:8000/api/v1/categories?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "links": [
            {
                "url": "string",
                "label": "string",
                "active": true
            }
        ],
        "path": "http://localhost:8000/api/v1/categories",
        "per_page": 15,
        "to": 15,
        "total": 42
    }
}
🟠401
Modified at 2026-01-31 12:19:01
Previous
Get category
Next
Get unit details
Built with