POST

Rooms.Count

Return the number of rooms/resources matching optional filters.

Permissions

  • User must be logged in with a valid bearer token.
  • The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Returns only the count for Rooms using the same filters as the list function.

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.
  • On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
  • Send parameters as POST body fields exactly as documented.

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
search
post
stringmainCounts rooms matching this text.
city
post
stringTel AvivCounts rooms in this city.
area
post
stringCenterCounts rooms in this area.
status
post
int1Counts rooms by active/inactive status when stored.

Authentication

Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Rooms.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "city": "Tel Aviv"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Rooms.Count",
    "url_domain": "https:\/\/{domain}\/app\/Rooms.Count"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 4
}

Count Only

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

{
    "url": "\/app\/Rooms.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Rooms.Count",
    "url_domain": "https:\/\/{domain}\/app\/Rooms.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "city": "Tel Aviv"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Total number of rooms matching the same filters accepted by Rooms.List."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('city', 'Tel Aviv');

const res = await fetch('https://{domain}/app/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({ city: 'Tel Aviv' });

const res = await fetch('/app/Rooms.Count', {
  method: 'POST',
  headers: { Authorization: 'Bearer ' + token },
  body
});

const data = await res.json();
console.log(data);

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}