POST

Customer.Rooms.List

List rooms for the organization so the client can book, from table rooms. Uses contactus.user_id (dashboard room. Optional rooms_type filter (dashboard booking form room_id is rooms_type). Staff Rooms.List is unchanged.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Runs the Customer.Rooms.List function and returns JSON.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
Send parameters as POST body fields exactly as documented.
For paging, do not request more than 25 rows.
For total rows, call the matching Count function with the same filters.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`rooms_type` post	int	`3`	Filter by rooms.rooms_type. Aliases: room_id, type.
`search` post	string	`deluxe`	Search name, description, city.
`start` post	int	`0`	Row offset.
`limit` post	int	`25`	Page size, capped at 25.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Customer.Rooms.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Rooms.List",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Rooms.List"
}

Endpoint

POST /app/Customer.Rooms.List
POST https://{user}.bull36.com/app/Customer.Rooms.List
POST https://{domain}/app/Customer.Rooms.List

Sample Output

{
    "success": 1,
    "count": 1,
    "data": [
        {
            "id": 4,
            "name": "Deluxe",
            "rooms_type": 3,
            "price": 200
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Customer.Rooms.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Rooms.Count",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Rooms.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use the matching count route when available, or count returned rows.",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

const res = await fetch('https://{domain}/app/Customer.Rooms.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('limit', '25');

const res = await fetch('/app/Customer.Rooms.List', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "error": "customer_login_required"
}