POST

Calendar.List

List calendar appointments from the appointments table for the logged-in account owner. Use Calendar.Get for a single event. Max 25 rows per page.

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 Calendar rows as JSON.
  • Supports the documented filters and paging fields.
  • List responses are capped at 25 rows per call.

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.
  • 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

NameTypeSampleWhat it gives
page
post
int1Page number (1-based).
limit
post
int25Max rows (capped at 25).
start
post
int0Row offset.
customer_id
post
int108545Filter by customer. Aliases: client_id, cust_id.
team_member_id
post
int14Filter by team member 1 or 2.
from_date
post
date2026-07-01Filter c_date >= from_date (Y-m-d). Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
to_date
post
date2026-07-31Filter c_date <= to_date (Y-m-d). Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
color
post
stringredFilter by color. Alias: appoinment_color.

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\/Calendar.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "from_date": "2026-07-01",
        "to_date": "2026-07-31",
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Calendar.List",
    "url_domain": "https:\/\/{domain}\/app\/Calendar.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 2,
    "total": 2,
    "source": "mysql.appointments",
    "data": [
        {
            "appointment_id": 9001,
            "title": "test add event",
            "color": "red",
            "date_time": "29.07.2026 04:00"
        }
    ]
}

Count Only

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

{
    "url": "\/app\/Calendar.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Calendar.Count",
    "url_domain": "https:\/\/{domain}\/app\/Calendar.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "from_date": "2026-07-01",
        "to_date": "2026-07-31"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "total": "Total matching appointments.",
        "count": "Rows in this page."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('from_date', '2026-07-01');
body.set('to_date', '2026-07-31');

const res = await fetch('https://{domain}/app/Calendar.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('from_date', '2026-07-01');
body.set('to_date', '2026-07-31');
body.set('limit', '25');
const res = await fetch('/app/Calendar.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

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