Introduction

Welcome to the ResMan Integration API. This API provides programmatic access to property data, floor plans, and unit availability retrieved directly from the ResMan property management system.

The API is divided into two main sections:

  • Public Front API: Designed for frontend websites (e.g., custom availability grids).
  • Authenticated API (v1): Secure endpoints for management and deep data retrieval.

Authentication

Endpoints under /api/v1/ require a Bearer token in the Authorization header. Public endpoints under /api/front/ do not require a token.

Authorization: Bearer YOUR_API_TOKEN

Tokens can be managed in the system dashboard under user settings.

API Login

POST
Endpoint
{{ $baseUrl }}/api/v1/auth/login

Body (JSON)

Field Type Description
email String User's registered email.
password String User's password.

Example Response

{
  "status": true,
  "msg": "Login successful",
  "api_token": "your_secure_token_here",
  "user": { "name": "Admin", "email": "[email protected]" }
}

Get Floor Plans

GET
Endpoint
{{ $baseUrl }}/api/front/floorplans

Parameters

Name Location Description
property_id Query Required. The unique ResMan property ID.

Example Call

GET /api/front/floorplans?property_id={{ $samplePropertyId }}

Response Schema Example

{
  "status": true,
  "msg": "Success",
  "data": [
    {
      "Id": "FP_ID_123",
      "Name": "The Modern Loft",
      "UnitsAvailable": "5",
      "Bedroom": 2,
      "Bathroom": "2.0",
      "SquareFeet": 1150,
      "Rent-Min": 1850,
      "Rent-Max": 2100,
      "TotalRent": 2100,
      "image_local_url": "https://yoursite.com/assets/floorplans/loft.webp",
      "action": "...button html code..."
    }
  ],
  "special_offer": {
    "title": "One Month Free!",
    "content": "Sign a lease by end of month..."
  },
  "filter": {
    "rent": [1800, 2500],
    "beds": [1, 2, 3],
    "baths": [1, 1.5, 2]
  }
}

Get Unit Availability

GET
Endpoint
{{ $baseUrl }}/api/front/units

Parameters

Name Location Description
property_id Query Required. UUID assigned by ResMan.
u Query Optional. Floor plan ID or name to filter units.

Example Call

GET /api/front/units?property_id={{ $samplePropertyId }}&u=1BED_A

Response Schema Example

{
  "status": true,
  "msg": "Success",
  "Availability": "https://subdomain.resman...Portal/Applicants",
  "units": {
    "1BED_A": [
      {
        "UnitID": "101",
        "Bedroom": 1,
        "Bathroom": "1.00",
        "SquareFeet": 750,
        "MarketRent": "1450.00",
        "TotalRent": "1450.00",
        "UnitEconomicStatus": "Vacant",
        "AvailDate": "Move in Today!",
        "Availability": {
          "VacateDate": "04/01/2026",
          "MadeReadyDate": "04/05/2026"
        }
      }
    ]
  }
}