TeamHours.WhenStop
Called before stopping the header Time clock (dashboard Setting::team_hours_when_stop). Returns today hours and mission summary fields. The dashboard stop-modal note is currently empty (product change), but hours_today and mission lists are included for app clients. After this, call TeamHours.StartStop with timer_action=stop (and optional note).
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
- Runs the TeamHours.WhenStop 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.
- 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
No optional body parameters are defined for this function.
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\/TeamHours.WhenStop",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": [],
"url_user": "https:\/\/{user}.bull36.com\/app\/TeamHours.WhenStop",
"url_domain": "https:\/\/{domain}\/app\/TeamHours.WhenStop"
}Endpoint
POST /app/TeamHours.WhenStop
POST https://{user}.bull36.com/app/TeamHours.WhenStop
POST https://{domain}/app/TeamHours.WhenStopSample Output
{
"success": 1,
"note": "",
"hours_today": 3,
"done_missions_total": 2,
"query_missions": [],
"testing_missions": [],
"done_missions": []
}JavaScript Example
const token = 'YOUR TOKEN';
const res = await fetch('/app/TeamHours.WhenStop', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body: new URLSearchParams() });
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"
}