Room Availability

Overview

The Room Availability endpoint returns room availability information for a specified date range. The data is grouped by room type (identified by resourceId which corresponds to the room_type_id), providing availability counts and occupancy details for operational planning and inventory management.

This endpoint is commonly used for availability calendars, forecasting, and distribution management.

Request Endpoint

• HTTP Method: POST
• Secure URL Path: {{base_url}}/api/room-availability

Authorization

Requires the following permission:

• Permission: integration-room-availability

Payload Construction and Schema Definition

The request payload is submitted as form-data fields.

Request Body Fields

Field	Type	Required	Description	Example
username	string	Yes	API account username provided by GuestPro.	demo_user
password	string	Yes	API account password provided by GuestPro.	••••••••
company_code	string	Yes	Property/company identifier bound to your API account.	gusadidev
start_date	string (date)	Yes	Start date for availability report (YYYY-MM-DD format).	2026-04-01
end_date	string (date)	Yes	End date for availability report (YYYY-MM-DD format).	2026-04-30

Response Body Fields

Field	Type	Always present	Description
error	boolean	Yes	Indicates whether the request failed. false means success.
status	string	Yes	Status string. On success the example returns "ok".
message	string	Yes	Human-readable message. Often empty on success.
data	array<object>	Yes (on success)	Array of room type availability objects.

Response data Fields

Field	Type	Description	Example
id	string	Room type identifier.	626ce0b0-95ac-11f1-966d-3b8bd5580ecb
resourceId	string	Room type identifier (matches room_type_id).	02186030-434c-11ef-b3d8-1f92297415a2
startDate	string (date)	start date.	2026-07-01
endDate	string (date)	end date.	2026-07-02
total_available	number	total of available rooms .	2

Expected System Responses

The system responds with HTTP 200 OK.

{
  "error": false,
  "status": "ok",
  "message": "",
  "data": [
    {
      {
            "id": "626ce0b0-95ac-11f1-966d-3b8bd5580ecb",
            "resourceId": "02186030-434c-11ef-b3d8-1f92297415a2",
            "startDate": "2026-07-01",
            "endDate": "2026-07-02",
            "total_available": 2
        }
    }
  ]
}