Developers
Biz1 API guide: authentication, documents, leads, and customer fields — with code samples.
Below are 110 operations. Each includes a full parameter table, code samples (GET and POST), and Try it to run a real request from this page — no separate documentation site required.
Base URL pattern: https://{user}.{domain}/. To add or tweak fields, edit lib/api-doc-catalog-infer.ts (TITLE_TO_API_KEY and parameter rules).
CRM School
Base URLs
The API base URL is per tenant: https://{user}.{domain}/ — {user} is your account subdomain and {domain} is your organization’s primary domain (e.g. biz1.co.il, bull36.com).
Most operations accept the same fields as GET (query string) or POST (JSON or form body). Each operation below includes Try it on this page.
https://{user}.{domain}/api.phphttps://{user}.{domain}/api/get_documenthttps://{user}.{domain}/dashboard/api/filesview(PDF)- Example:
https://acme.biz1.co.il/api.php?api=...
Endpoints overview and the full catalog
Biz1 exposes APIs for files & folders, missions & projects, time tracking, extensions, documents (many “Add Order2” / “Create document” cards share one route with different document_type), auth & users, CRM, calendar & appointments, payments, integrations, communications, tickets & orders, and automation. The full list is in the API reference sections below — each entry has parameters, code samples, and Try it.
The table here summarizes common URL patterns only. Host prefix is always https://{user}.{domain}/ (your tenant).
| Area | URL / pattern | Notes |
|---|---|---|
| Create documents (JSON) | POST https://{user}.{domain}/api.php?api=add_order2 or api=create_document | JSON body — invoices, receipts, orders, etc. |
| Retrieve / list documents | GET https://{user}.{domain}/api/get_document?api_token=...&... | Query-string parameters |
| View PDF | https://{user}.{domain}/dashboard/api/filesview?url=... | url encoded path from API metadata |
| New lead | https://{user}.{domain}/api.php?api=add_lead&api_token=... | Usually GET; standard fields + cf-* custom |
| Update customer field | https://{user}.{domain}/api.php?api=update_field&... | Customer id or email |
Samples below use add_order2; you may swap to create_document with the same JSON body. Most dashboard entries titled “documentation (Add Order2)” are the same mechanism with a different document type.
API token (api_token)
Identifies your account. Found in the primary user settings (often at the bottom of the settings page). Invalid or missing tokens reject the request.
| Parameter | Required | Description |
|---|---|---|
| api_token | Yes | Your organization API key |
Create documents (unified API)
This section is only for creating documents. Other operations — get_document, filesview, add_lead, update_field — are covered in their own sections and in the Endpoints overview and the full catalog table above. For creation, the aliases add_order2 and create_document are equivalent.
https://{user}.{domain}/api.php?api=add_order2https://{user}.{domain}/api.php?api=create_document(backward compatibility)
Main JSON body fields
| Field | Required | Description |
|---|---|---|
| api_token | Yes | Authentication |
| document_type | Yes | Selects document engine, validation, PDF template, line items / payment rules |
| cust_id | No | Existing customer; if omitted, match or create by name/email/phone |
| order | Type-dependent | Document scope: currency, VAT, notes, discounts |
| items / products | Type-dependent | Line items: SKU, qty, price; some receipts may use all_items_total instead |
Exact payloads depend on your account and document_type — use the parameter table and Try it below for common fields.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Replace {user}.{domain} with your account host (e.g. acme.biz1.co.il).
# Same JSON body for api=add_order2 OR api=create_document (equivalent).
curl -sS -X POST 'https://{user}.{domain}/api.php?api=add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN","document_type":"invoice","cust_id":12345,"order":{"currency":"ILS","vat_percent":18}}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Retrieve documents
https://{user}.{domain}/api/get_document
Filters by customer, document type, and dates; returns metadata and PDF paths.
| Example parameter | Description |
|---|---|
| api_token | Auth |
| cust_id | Customer |
| document_type | Filter by type |
| from_date / to_date | Date range |
Use the parameter names in the table below; Try it sends the same fields as GET or POST.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
curl -sS 'https://{user}.{domain}/api/get_document?api_token=YOUR_API_TOKEN&cust_id=12345&document_type=invoice&from_date=2026-01-01&to_date=2026-12-31'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
View PDF
Streams PDFs securely; url is the encoded path returned by the system.
https://{user}.{domain}/dashboard/api/filesview?url=ENCODED_PDF_PATH
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
curl -sS -O -J 'https://{user}.{domain}/dashboard/api/filesview?url=ENCODED_PDF_PATH'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Leads — add_lead
Send the same fields as GET (query string) or POST (JSON or form). Use Try it below.
| Field | Notes |
|---|---|
| phone, mobile, source, address, email, name, message, company, password | Standard fields |
| cf-* | Custom field: English name with cf- prefix (e.g. cf-test) |
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
curl -sS 'https://{user}.{domain}/api.php?api=add_lead&api_token=YOUR_API_TOKEN&source=website&name=Jane&[email protected]&mobile=0500000000&message=Hello'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Update customer field — update_field
Identifies the customer by id or email; supports custom fields.
Supports values like today, hour per documentation.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
curl -sS 'https://{user}.{domain}/api.php?api_token=YOUR_API_TOKEN&api=update_field&field=notes&value=Updated&id=12345'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Document creation pipeline (summary)
- Validate api_token
- Resolve document_type
- Resolve or create customer
- Process order and lines
- Payment (receipt flows)
- Automation flags
- Persist, PDF, optional delivery
get reminder data list
Returns reminder data for the authenticated user (exact fields are shown in the dashboard Test API table for this operation).
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_reminder_data_list
Your tenant: https://{user}.{domain}/api/get_reminder_data_list · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_reminder_data_list?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_reminder_data_list) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_reminder_data_list instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
cust_id | number | contatctus table id |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_reminder_data_list?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=value
api_token => (Required) – user api token from setting cust_id => (Required) – contatctus table id phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get reminder data list
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_reminder_data_list.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_reminder_data_list?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=value'
curl -sS -G 'https://{user}.{domain}/api/get_reminder_data_list' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'phone=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_reminder_data_list' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545","phone":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get all documents data
This API is used to all document data get for a user.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_all_documents_data
Your tenant: https://{user}.{domain}/api/get_all_documents_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_all_documents_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_all_documents_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_all_documents_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
cust_id | number | contatctus table id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_all_documents_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545
api_token => (Required) – user api token from setting cust_id => (Required) – contatctus table id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get all documents data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_all_documents_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_all_documents_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/get_all_documents_data' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_all_documents_data' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Edit client file api
This API is used to edit notes in client files.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/edit_client_file_api
Your tenant: https://{user}.{domain}/api/edit_client_file_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/edit_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&data_val=test — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/edit_client_file_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=edit_client_file_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
data_id | number | client file id |
data_val | string | updated notes |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/edit_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&data_val=test
api_token => (Required) – user api token from setting data_id => (Required) – client file id data_val => (Required) – updated notes
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Edit client file api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=edit_client_file_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/edit_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&data_val=test'
curl -sS -G 'https://{user}.{domain}/api/edit_client_file_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'data_id=650' \
--data-urlencode 'data_val=test'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/edit_client_file_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","data_id":"650","data_val":"test"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Delete client file api
This API is used to delete client files.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/delete_client_file_api
Your tenant: https://{user}.{domain}/api/delete_client_file_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/delete_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&file_id=650 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/delete_client_file_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=delete_client_file_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
file_id | number | client file id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/delete_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&file_id=650
api_token => (Required) – user api token from setting file_id => (Required) – client file id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Delete client file api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=delete_client_file_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/delete_client_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&file_id=650'
curl -sS -G 'https://{user}.{domain}/api/delete_client_file_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'file_id=650'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/delete_client_file_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","file_id":"650"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get mission count data
This API is used to get mission counts by type, such as My Missions, Created by Me, and All Team Missions.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_mission_count_data
Your tenant: https://{user}.{domain}/api/get_mission_count_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_mission_count_data?api_token=YOUR_API_TOKEN_FROM_SETTING&type_of_mission=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_mission_count_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_mission_count_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
type_of_mission | string | type of mission (done,not_done)) |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_mission_count_data?api_token=YOUR_API_TOKEN_FROM_SETTING&type_of_mission=value
api_token => (Required) – user api token from setting type_of_mission => (Required) – type of mission (done,not_done))
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get mission count data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_mission_count_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_mission_count_data?api_token=YOUR_API_TOKEN_FROM_SETTING&type_of_mission=value'
curl -sS -G 'https://{user}.{domain}/api/get_mission_count_data' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'type_of_mission=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_mission_count_data' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","type_of_mission":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
user upload client file
This API is used to upload client files for a user.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/user_upload_client_file
Your tenant: https://{user}.{domain}/api/user_upload_client_file · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/user_upload_client_file?api_token=YOUR_API_TOKEN_FROM_SETTING&folder=value¬es=value&cust_id=108545 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/user_upload_client_file) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=user_upload_client_file instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
folder | string | folder name or folder id |
notes | string | file notes |
cust_id | number | customer id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/user_upload_client_file?api_token=YOUR_API_TOKEN_FROM_SETTING&folder=value¬es=value&cust_id=108545
api_token => (Required) – user api token from setting folder => (Required) – folder name or folder id notes => (Required) – file notes cust_id => (Required) – customer id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: user upload client file
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=user_upload_client_file.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/user_upload_client_file?api_token=YOUR_API_TOKEN_FROM_SETTING&folder=value¬es=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/user_upload_client_file' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'folder=value' \
--data-urlencode 'notes=value' \
--data-urlencode 'cust_id=108545'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/user_upload_client_file' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","folder":"value","notes":"value","cust_id":"108545"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get global folders data
This api is used for get main folders detail
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_global_folders_data
Your tenant: https://{user}.{domain}/api/get_global_folders_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_global_folders_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_global_folders_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_global_folders_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
cust_id | number | search by customer id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_global_folders_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545
api_token => (Required) – user api token from setting cust_id => (Required) – search by customer id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get global folders data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_global_folders_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_global_folders_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/get_global_folders_data' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_global_folders_data' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get sub folder html
This api is used for get sub folder
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_sub_folder_html
Your tenant: https://{user}.{domain}/api/get_sub_folder_html · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_sub_folder_html?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&cust_id=108545 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_sub_folder_html) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_sub_folder_html instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
data_id | number | parent folder id |
cust_id | number | search by customer id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_sub_folder_html?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&cust_id=108545
api_token => (Required) – user api token from setting data_id => (Required) – parent folder id cust_id => (Required) – search by customer id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get sub folder html
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_sub_folder_html.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_sub_folder_html?api_token=YOUR_API_TOKEN_FROM_SETTING&data_id=650&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/get_sub_folder_html' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'data_id=650' \
--data-urlencode 'cust_id=108545'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_sub_folder_html' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","data_id":"650","cust_id":"108545"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get user files data
This api is used for get all user files
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_user_files_data
Your tenant: https://{user}.{domain}/api/get_user_files_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_user_files_data?api_token=YOUR_API_TOKEN_FROM_SETTING&active_folder=value&name_search=value&cust_id=108545 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_user_files_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_user_files_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
active_folder | string | search by folder name |
name_search | string | search by file name |
cust_id | number | search by customer id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_user_files_data?api_token=YOUR_API_TOKEN_FROM_SETTING&active_folder=value&name_search=value&cust_id=108545
api_token => (Required) – user api token from setting active_folder => (Required) – search by folder name name_search => (Required) – search by file name cust_id => (Required) – search by customer id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get user files data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_user_files_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_user_files_data?api_token=YOUR_API_TOKEN_FROM_SETTING&active_folder=value&name_search=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/get_user_files_data' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'active_folder=value' \
--data-urlencode 'name_search=value' \
--data-urlencode 'cust_id=108545'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_user_files_data' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","active_folder":"value","name_search":"value","cust_id":"108545"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Remove mission image api
This API is used to remove files from a mission.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/remove_mission_image_api
Your tenant: https://{user}.{domain}/api/remove_mission_image_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/remove_mission_image_api?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value&data_name=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/remove_mission_image_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=remove_mission_image_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
id | string | Mission ID to remove file |
data_name | string | delete file name for mission |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/remove_mission_image_api?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value&data_name=value
api_token => (Required) – user api token from setting id => (Required) – Mission ID to remove file data_name => (Required) – delete file name for mission
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Remove mission image api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=remove_mission_image_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/remove_mission_image_api?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value&data_name=value'
curl -sS -G 'https://{user}.{domain}/api/remove_mission_image_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'id=value' \
--data-urlencode 'data_name=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/remove_mission_image_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","id":"value","data_name":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get project details
This API is used to retrieve user project data.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_project_details
Your tenant: https://{user}.{domain}/api/get_project_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_project_details?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_project_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_project_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_project_details?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get project details
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_project_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_project_details?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/get_project_details' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_project_details' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get multiple customer
This Api Retrieves customer details based on one or more identifiers such as customer name, phone number, or email address. Requires a valid API token for authorization.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_multiple_customer
Your tenant: https://{user}.{domain}/api/get_multiple_customer · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_multiple_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&name=Jane — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_multiple_customer) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_multiple_customer instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
phone | string | |
email | string | |
name | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_multiple_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&name=Jane
api_token => (Required) – — phone => (Optional) – — email => (Required) – — name => (Required) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get multiple customer
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_multiple_customer.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_multiple_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&name=Jane'
curl -sS -G 'https://{user}.{domain}/api/get_multiple_customer' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'phone=0500000000' \
--data-urlencode '[email protected]' \
--data-urlencode 'name=Jane'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_multiple_customer' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","phone":"0500000000","email":"[email protected]","name":"Jane"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get selected extension details
This api used to single extension get
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_selected_extension_details
Your tenant: https://{user}.{domain}/api/get_selected_extension_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_selected_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_selected_extension_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_selected_extension_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
extension_id | number | extension table id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_selected_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value
api_token => (Required) – user api token from setting extension_id => (Required) – extension table id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get selected extension details
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_selected_extension_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_selected_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value'
curl -sS -G 'https://{user}.{domain}/api/get_selected_extension_details' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'extension_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_selected_extension_details' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","extension_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
update extension by loginUser api
This api used to extension update in user
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/update_extension_by_loginuser_api
Your tenant: https://{user}.{domain}/api/update_extension_by_loginuser_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/update_extension_by_loginuser_api?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value&extension_number=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/update_extension_by_loginuser_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=update_extension_by_loginuser_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
extension_id | number | extension table id |
extension_number | string | extension name |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/update_extension_by_loginuser_api?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value&extension_number=value
api_token => (Required) – user api token from setting extension_id => (Required) – extension table id extension_number => (Required) – extension name
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: update extension by loginUser api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=update_extension_by_loginuser_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/update_extension_by_loginuser_api?api_token=YOUR_API_TOKEN_FROM_SETTING&extension_id=value&extension_number=value'
curl -sS -G 'https://{user}.{domain}/api/update_extension_by_loginuser_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'extension_id=value' \
--data-urlencode 'extension_number=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/update_extension_by_loginuser_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","extension_id":"value","extension_number":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get extension details
This api used to user all extension get
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_extension_details
Your tenant: https://{user}.{domain}/api/get_extension_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_extension_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_extension_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – user api token from setting
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get extension details
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_extension_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_extension_details?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/get_extension_details' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_extension_details' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
stop time counter
This api is used to customer timer stop
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/stop_time_counter
Your tenant: https://{user}.{domain}/api/stop_time_counter · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/stop_time_counter?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/stop_time_counter) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=stop_time_counter instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
contactus_id | number | contatctus table id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/stop_time_counter?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value
api_token => (Required) – user api token from setting contactus_id => (Required) – contatctus table id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: stop time counter
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=stop_time_counter.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/stop_time_counter?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value'
curl -sS -G 'https://{user}.{domain}/api/stop_time_counter' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'contactus_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/stop_time_counter' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","contactus_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
add time counter start
This api is used customer timer start
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_time_counter_start
Your tenant: https://{user}.{domain}/api/add_time_counter_start · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_time_counter_start?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_time_counter_start) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_time_counter_start instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
contactus_id | number | contatctus table id |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_time_counter_start?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value
api_token => (Required) – user api token from setting contactus_id => (Required) – contatctus table id
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: add time counter start
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_time_counter_start.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_time_counter_start?api_token=YOUR_API_TOKEN_FROM_SETTING&contactus_id=value'
curl -sS -G 'https://{user}.{domain}/api/add_time_counter_start' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'contactus_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_time_counter_start' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","contactus_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
add stop time
This API is used to user timer stop
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_stop_time
Your tenant: https://{user}.{domain}/api/add_stop_time · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_stop_time?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value¬e=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_stop_time) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_stop_time instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
id | string | id from the team_hours table |
note | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_stop_time?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value¬e=value
api_token => (Required) – user api token from setting id => (Required) – id from the team_hours table note => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: add stop time
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_stop_time.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_stop_time?api_token=YOUR_API_TOKEN_FROM_SETTING&id=value¬e=value'
curl -sS -G 'https://{user}.{domain}/api/add_stop_time' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'id=value' \
--data-urlencode 'note=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_stop_time' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","id":"value","note":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
team hours when stop
This API is used to timer stop after add note in user timer
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/team_hours_when_stop
Your tenant: https://{user}.{domain}/api/team_hours_when_stop · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/team_hours_when_stop?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/team_hours_when_stop) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=team_hours_when_stop instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/team_hours_when_stop?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – user api token from setting
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: team hours when stop
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=team_hours_when_stop.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/team_hours_when_stop?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/team_hours_when_stop' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/team_hours_when_stop' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
add start time
This api use team member timer start
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_start_time
Your tenant: https://{user}.{domain}/api/add_start_time · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_start_time?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_start_time) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_start_time instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_start_time?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – user api token from setting
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: add start time
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_start_time.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_start_time?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/add_start_time' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_start_time' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get sip details
This api use in get biz1 sip detail
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_sip_details
Your tenant: https://{user}.{domain}/api/get_sip_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_sip_details?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_sip_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_sip_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | user api token from setting |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_sip_details?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – user api token from setting
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get sip details
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_sip_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_sip_details?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/get_sip_details' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_sip_details' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create note
This api use create note
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_note
Your tenant: https://{user}.{domain}/api/create_note · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_note?token=YOUR_API_TOKEN — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_note) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_note instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | user api token from setting |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_note?token=YOUR_API_TOKEN
token => (Required) – user api token from setting
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create note
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_note.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_note?token=YOUR_API_TOKEN'
curl -sS -G 'https://{user}.{domain}/api/create_note' \
--data-urlencode 'token=YOUR_API_TOKEN'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_note' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
update fix fields value
This API is used to update fix fields value based on id
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/update_fix_fields_value
Your tenant: https://{user}.{domain}/api/update_fix_fields_value · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/update_fix_fields_value?token=YOUR_API_TOKEN&id=value&value=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/update_fix_fields_value) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=update_fix_fields_value instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | user api token from setting |
id | string | id from the fix fields table |
value | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/update_fix_fields_value?token=YOUR_API_TOKEN&id=value&value=value
token => (Required) – user api token from setting id => (Required) – id from the fix fields table value => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: update fix fields value
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=update_fix_fields_value.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/update_fix_fields_value?token=YOUR_API_TOKEN&id=value&value=value'
curl -sS -G 'https://{user}.{domain}/api/update_fix_fields_value' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'id=value' \
--data-urlencode 'value=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/update_fix_fields_value' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","id":"value","value":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get affiliate details
This API is used to get log details based on affiliate id
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_affiliate_details
Your tenant: https://{user}.{domain}/api/get_affiliate_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_affiliate_details?token=YOUR_API_TOKEN&affiliate_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_affiliate_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_affiliate_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | user api token from setting |
affiliate_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_affiliate_details?token=YOUR_API_TOKEN&affiliate_id=value
token => (Required) – user api token from setting affiliate_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get affiliate details
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_affiliate_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_affiliate_details?token=YOUR_API_TOKEN&affiliate_id=value'
curl -sS -G 'https://{user}.{domain}/api/get_affiliate_details' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'affiliate_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_affiliate_details' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","affiliate_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
delete mission api
This API is used to delete a mission (task) for a specific lead.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/delete_mission
Your tenant: https://{user}.{domain}/api/delete_mission · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/delete_mission?token=YOUR_API_TOKEN&id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/delete_mission) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=delete_mission instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | API key to authenticate user |
id | string | Mission ID to delete |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/delete_mission?token=YOUR_API_TOKEN&id=value
token => (Required) – API key to authenticate user id => (Required) – Mission ID to delete
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: delete mission api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=delete_mission.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/delete_mission?token=YOUR_API_TOKEN&id=value'
curl -sS -G 'https://{user}.{domain}/api/delete_mission' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/delete_mission' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
edit mission status api
This API is used to edit a mission status (mark done) for a specific lead.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/edit_mission_status
Your tenant: https://{user}.{domain}/api/edit_mission_status · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/edit_mission_status?token=YOUR_API_TOKEN&id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/edit_mission_status) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=edit_mission_status instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | API key to authenticate user |
id | string | Mission ID to edit status |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/edit_mission_status?token=YOUR_API_TOKEN&id=value
token => (Required) – API key to authenticate user id => (Required) – Mission ID to edit status
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: edit mission status api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=edit_mission_status.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/edit_mission_status?token=YOUR_API_TOKEN&id=value'
curl -sS -G 'https://{user}.{domain}/api/edit_mission_status' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/edit_mission_status' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create receipt documentation(Add Order2)
create receipt document by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value&number_of_payments=value&payment_type=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string | |
number_of_payments | string | |
payment_type | string | Set the number of installments for split payments; otherwise, leave this field blank for regular payments |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value&number_of_payments=value&payment_type=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – — number_of_payments => (Optional) – — payment_type => (Required) – Set the number of installments for split payments; otherwise, leave this field blank for regular payments
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create receipt documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value' \
--data-urlencode 'number_of_payments=value' \
--data-urlencode 'payment_type=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value","number_of_payments":"value","payment_type":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create organization_receipt documentation(Add Order2)
create organization_receipt document by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create organization_receipt documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create delivery_invoice documentation(Add Order2)
create delivery document by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create delivery_invoice documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create proforma_invoice documentation(Add Order2)
create proforma_invoice document by the api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create proforma_invoice documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create detail_orders documentation(Add Order2)
create detail_orders documentation by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create detail_orders documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create purchase_orders documentation(Add Order2)
create purchase_orders document by the api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create purchase_orders documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create order_proposals documentation(Add Order2)
create order_proposals document by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create order_proposals documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create delivery return documentation(Add Order2)
create delivery return documentation by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create delivery return documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create receipt_tax_invoice documentation(Add Order2)
create receipt_tax_invoice by api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create receipt_tax_invoice documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create invoice documentation(Add Order2)
create invoice document from api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create invoice documentation(Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get auth
get auth details based on api_token user_id and ip address
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_auth
Your tenant: https://{user}.{domain}/api/get_auth · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_auth) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_auth instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
user_id | number | |
ip | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value
api_token => (Required) – — user_id => (Optional) – — ip => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get auth
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_auth.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value'
curl -sS -G 'https://{user}.{domain}/api/get_auth' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'user_id=14' \
--data-urlencode 'ip=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_auth' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","user_id":"14","ip":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
create auth
create auth based on api_token user_id and ip
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_auth
Your tenant: https://{user}.{domain}/api/create_auth · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_auth) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_auth instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
user_id | number | if user from (14,47 or 44636) then pass the support other wise pass the user_id |
ip | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value
api_token => (Required) – — user_id => (Required) – if user from (14,47 or 44636) then pass the support other wise pass the user_id ip => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: create auth
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_auth.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_auth?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&ip=value'
curl -sS -G 'https://{user}.{domain}/api/create_auth' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'user_id=14' \
--data-urlencode 'ip=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_auth' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","user_id":"14","ip":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get user details by api
get user details based on api token you can pass also team member token and get all details
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_user_details
Your tenant: https://{user}.{domain}/api/get_user_details · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_user_details?token=YOUR_API_TOKEN — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_user_details) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_user_details instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_user_details?token=YOUR_API_TOKEN
token => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get user details by api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_user_details.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_user_details?token=YOUR_API_TOKEN'
curl -sS -G 'https://{user}.{domain}/api/get_user_details' \
--data-urlencode 'token=YOUR_API_TOKEN'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_user_details' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
edit mission
This API is used to edit a mission (task) for a specific customer or lead. It allows assigning the mission to team members, setting a due date and time, adding notes, tags, reminders, etc..
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/edit_mission
Your tenant: https://{user}.{domain}/api/edit_mission · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/edit_mission?token=YOUR_API_TOKEN&id=value&cust_id=108545&mission=value&date_to_do=2026-04-08%2010%3A00&time=value&member_id=value¬e=value&project_id=value&tag_id=value&repeat_days=value&color=value&show_mission=value&use_as_template=value¬ify_client=value&email_me_employee=value&missions_steps_id=value&days_after_ads=value&project_column=value&whatsApp_reminder=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/edit_mission) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=edit_mission instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
id | string | |
cust_id | number | |
mission | string | |
date_to_do | string | YYYY-MM-DD HH:SS |
time | string | |
member_id | number | |
note | string | |
project_id | number | |
tag_id | number | |
repeat_days | string | "monthly", "weekly", "daily" you only this value |
color | string | 'transparent','yellow','green','red','blue' you only this value |
show_mission | string | |
use_as_template | string | |
notify_client | string | |
email_me_employee | string | |
missions_steps_id | number | |
days_after_ads | string | |
project_column | string | |
whatsApp_reminder | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/edit_mission?token=YOUR_API_TOKEN&id=value&cust_id=108545&mission=value&date_to_do=2026-04-08%2010%3A00&time=value&member_id=value¬e=value&project_id=value&tag_id=value&repeat_days=value&color=value&show_mission=value&use_as_template=value¬ify_client=value&email_me_employee=value&missions_steps_id=value&days_after_ads=value&project_column=value&whatsApp_reminder=value
token => (Optional) – — id => (Optional) – — cust_id => (Optional) – — mission => (Optional) – — date_to_do => (Required) – YYYY-MM-DD HH:SS time => (Optional) – — member_id => (Optional) – — note => (Optional) – — project_id => (Optional) – — tag_id => (Optional) – — repeat_days => (Required) – "monthly", "weekly", "daily" you only this value color => (Required) – 'transparent','yellow','green','red','blue' you only this value show_mission => (Optional) – — use_as_template => (Optional) – — notify_client => (Optional) – — email_me_employee => (Optional) – — missions_steps_id => (Optional) – — days_after_ads => (Optional) – — project_column => (Optional) – — whatsApp_reminder => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: edit mission
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=edit_mission.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/edit_mission?token=YOUR_API_TOKEN&id=value&cust_id=108545&mission=value'
curl -sS -G 'https://{user}.{domain}/api/edit_mission' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'id=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'mission=value' \
--data-urlencode 'date_to_do=2026-04-08 10:00' \
--data-urlencode 'time=value' \
--data-urlencode 'member_id=value' \
--data-urlencode 'note=value' \
--data-urlencode 'project_id=value' \
--data-urlencode 'tag_id=value' \
--data-urlencode 'repeat_days=value' \
--data-urlencode 'color=value' \
--data-urlencode 'show_mission=value' \
--data-urlencode 'use_as_template=value' \
--data-urlencode 'notify_client=value' \
--data-urlencode 'email_me_employee=value' \
--data-urlencode 'missions_steps_id=value' \
--data-urlencode 'days_after_ads=value' \
--data-urlencode 'project_column=value' \
--data-urlencode 'whatsApp_reminder=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/edit_mission' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","id":"value","cust_id":"108545","mission":"value","date_to_do":"2026-04-08 10:00","time":"value","member_id":"value","note":"value","project_id":"value","tag_id":"value","repeat_days":"value","color":"value","show_mission":"value","use_as_template":"value","notify_client":"value","email_me_employee":"value","missions_steps_id":"value","days_after_ads":"value","project_column":"value","whatsApp_reminder":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Mission API
This API is used to create a new mission (task) for a specific customer or lead. It allows assigning the mission to team members, setting a due date and time, adding notes, tags, reminders, etc..
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_mission
Your tenant: https://{user}.{domain}/api/add_mission · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_mission?token=YOUR_API_TOKEN&cust_id=108545&mission=value&date_to_do=2026-04-08%2010%3A00&time=value&member_id=value¬e=value&project_id=value&tag_id=value&repeat_days=value&color=value&show_mission=value&use_as_template=value¬ify_client=value&email_me_employee=value&missions_steps_id=value&days_after_ads=value&project_column=value&whatsApp_reminder=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_mission) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_mission instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
cust_id | number | |
mission | string | |
date_to_do | string | YYYY-MM-DD HH:SS |
time | string | |
member_id | number | |
note | string | |
project_id | number | |
tag_id | number | |
repeat_days | string | "monthly", "weekly", "daily" you only this value |
color | string | 'transparent','yellow','green','red','blue' you only this value |
show_mission | string | |
use_as_template | string | |
notify_client | string | |
email_me_employee | string | |
missions_steps_id | number | |
days_after_ads | string | |
project_column | string | |
whatsApp_reminder | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_mission?token=YOUR_API_TOKEN&cust_id=108545&mission=value&date_to_do=2026-04-08%2010%3A00&time=value&member_id=value¬e=value&project_id=value&tag_id=value&repeat_days=value&color=value&show_mission=value&use_as_template=value¬ify_client=value&email_me_employee=value&missions_steps_id=value&days_after_ads=value&project_column=value&whatsApp_reminder=value
token => (Optional) – — cust_id => (Optional) – — mission => (Optional) – — date_to_do => (Required) – YYYY-MM-DD HH:SS time => (Optional) – — member_id => (Optional) – — note => (Optional) – — project_id => (Optional) – — tag_id => (Optional) – — repeat_days => (Required) – "monthly", "weekly", "daily" you only this value color => (Required) – 'transparent','yellow','green','red','blue' you only this value show_mission => (Optional) – — use_as_template => (Optional) – — notify_client => (Optional) – — email_me_employee => (Optional) – — missions_steps_id => (Optional) – — days_after_ads => (Optional) – — project_column => (Optional) – — whatsApp_reminder => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Mission API
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_mission.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_mission?token=YOUR_API_TOKEN&cust_id=108545&mission=value&date_to_do=2026-04-08%2010%3A00'
curl -sS -G 'https://{user}.{domain}/api/add_mission' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'mission=value' \
--data-urlencode 'date_to_do=2026-04-08 10:00' \
--data-urlencode 'time=value' \
--data-urlencode 'member_id=value' \
--data-urlencode 'note=value' \
--data-urlencode 'project_id=value' \
--data-urlencode 'tag_id=value' \
--data-urlencode 'repeat_days=value' \
--data-urlencode 'color=value' \
--data-urlencode 'show_mission=value' \
--data-urlencode 'use_as_template=value' \
--data-urlencode 'notify_client=value' \
--data-urlencode 'email_me_employee=value' \
--data-urlencode 'missions_steps_id=value' \
--data-urlencode 'days_after_ads=value' \
--data-urlencode 'project_column=value' \
--data-urlencode 'whatsApp_reminder=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_mission' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","cust_id":"108545","mission":"value","date_to_do":"2026-04-08 10:00","time":"value","member_id":"value","note":"value","project_id":"value","tag_id":"value","repeat_days":"value","color":"value","show_mission":"value","use_as_template":"value","notify_client":"value","email_me_employee":"value","missions_steps_id":"value","days_after_ads":"value","project_column":"value","whatsApp_reminder":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Mission
This API is used to fetch customer mission details by identifying a customer using Customer ID, phone number, or email address.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_mission
Your tenant: https://{user}.{domain}/api/get_mission · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_mission?token=YOUR_API_TOKEN&cust_id=108545&phone=0500000000&email=jane%40example.com — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_mission) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_mission instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
cust_id | number | |
phone | string | |
email | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_mission?token=YOUR_API_TOKEN&cust_id=108545&phone=0500000000&email=jane%40example.com
token => (Optional) – — cust_id => (Optional) – — phone => (Optional) – — email => (Required) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Mission
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_mission.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_mission?token=YOUR_API_TOKEN&cust_id=108545&phone=0500000000&email=jane%40example.com'
curl -sS -G 'https://{user}.{domain}/api/get_mission' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'phone=0500000000' \
--data-urlencode '[email protected]'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_mission' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","cust_id":"108545","phone":"0500000000","email":"[email protected]"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
get document
get last document by type and customer
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_document
Your tenant: https://{user}.{domain}/api/get_document · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_document?api_token=YOUR_API_TOKEN&cust_id=12345&document_type=invoice&from_date=2026-01-01&to_date=2026-12-31 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_document) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_document instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | API token from the main user account settings. |
cust_id | number | Customer ID. |
document_type | string | Document type (invoice, receipt, …). |
from_date | string | Start date YYYY-MM-DD. |
to_date | string | End date YYYY-MM-DD. |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_document?api_token=YOUR_API_TOKEN&cust_id=12345&document_type=invoice&from_date=2026-01-01&to_date=2026-12-31
api_token => (Required) – API token from the main user account settings. cust_id => (Optional) – Customer ID. document_type => (Optional) – Document type (invoice, receipt, …). from_date => (Optional) – Start date YYYY-MM-DD. to_date => (Optional) – End date YYYY-MM-DD.
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: get document
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_document.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_document?api_token=YOUR_API_TOKEN&cust_id=12345&document_type=invoice&from_date=2026-01-01'
curl -sS -G 'https://{user}.{domain}/api/get_document' \
--data-urlencode 'api_token=YOUR_API_TOKEN' \
--data-urlencode 'cust_id=12345' \
--data-urlencode 'document_type=invoice' \
--data-urlencode 'from_date=2026-01-01' \
--data-urlencode 'to_date=2026-12-31'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_document' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN","cust_id":"12345","document_type":"invoice","from_date":"2026-01-01","to_date":"2026-12-31"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
add customer custom tabs api
add customer tab based on api
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_customer_custom_tabs_api
Your tenant: https://{user}.{domain}/api/add_customer_custom_tabs_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_customer_custom_tabs_api?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=0500000000&email=jane%40example.com&data=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_customer_custom_tabs_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_customer_custom_tabs_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
cust_id | number | |
phone | string | |
email | string | |
data | string | tab_id => (Required) – The ID of the tab to be inserted. folder_id => (Required) – The ID of the folder to be inserted. tab-cf-s => (Optional) – The value of the field to be inserted. tbb-cf- with prefix tab-cf- is the field name. |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_customer_custom_tabs_api?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=0500000000&email=jane%40example.com&data=value
api_token => (Required) – — cust_id => (Optional) – — phone => (Optional) – — email => (Required) – — data => (Optional) – tab_id => (Required) – The ID of the tab to be inserted. folder_id => (Required) – The ID of the folder to be inserted. tab-cf-s => (Optional) – The value of the field to be inserted. tbb-cf- with prefix tab-cf- is the field name.
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: add customer custom tabs api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_customer_custom_tabs_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_customer_custom_tabs_api?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&phone=0500000000&email=jane%40example.com'
curl -sS -G 'https://{user}.{domain}/api/add_customer_custom_tabs_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'phone=0500000000' \
--data-urlencode '[email protected]' \
--data-urlencode 'data=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_customer_custom_tabs_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545","phone":"0500000000","email":"[email protected]","data":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Change Calender Meeting Color Api
change calendar appointment color for a customer by specifying the start time, date, and phone number, along with the customer’s authentication token.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/change_calender_meeting_color_api
Your tenant: https://{user}.{domain}/api/change_calender_meeting_color_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/change_calender_meeting_color_api?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&phone=0500000000&client_id=value&color=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/change_calender_meeting_color_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=change_calender_meeting_color_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
appo_from | string | must set HH:MM format as we set default value |
date | string | must set DD.MM.YYYY format as we set default value |
phone | string | |
client_id | number | |
color | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/change_calender_meeting_color_api?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&phone=0500000000&client_id=value&color=value
api_token => (Required) – — appo_from => (Required) – must set HH:MM format as we set default value date => (Required) – must set DD.MM.YYYY format as we set default value phone => (Optional) – — client_id => (Optional) – — color => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Change Calender Meeting Color Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=change_calender_meeting_color_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/change_calender_meeting_color_api?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/change_calender_meeting_color_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'appo_from=value' \
--data-urlencode 'date=value' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'client_id=value' \
--data-urlencode 'color=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/change_calender_meeting_color_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","appo_from":"value","date":"value","phone":"0500000000","client_id":"value","color":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Customer File Api
This API endpoint retrieves customer files stored in the system. It allows searching by phone, and returns all related files (such as files name,client_id,date,etc.)
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_customer_file_api
Your tenant: https://{user}.{domain}/api/get_customer_file_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_customer_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_customer_file_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_customer_file_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_customer_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000
api_token => (Required) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Customer File Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_customer_file_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_customer_file_api?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/get_customer_file_api' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_customer_file_api' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Customer By Api
This API endpoint enables creation of a new customer profile in the system. It captures essential client details such as name, contact info, subject, and message, helping automate customer setup within your booking or CRM environment.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_customer_by_api
Your tenant: https://{user}.{domain}/api/create_customer_by_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_customer_by_api?token=YOUR_API_TOKEN&user=value&name=Jane&email=jane%40example.com&subject=value&message=Hey%20I%20am%20here&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_customer_by_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_customer_by_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
user | string | |
name | string | |
email | string | |
subject | string | |
message | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_customer_by_api?token=YOUR_API_TOKEN&user=value&name=Jane&email=jane%40example.com&subject=value&message=Hey%20I%20am%20here&phone=0500000000
token => (Optional) – — user => (Optional) – — name => (Required) – — email => (Required) – — subject => (Optional) – — message => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Customer By Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_customer_by_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_customer_by_api?token=YOUR_API_TOKEN&user=value&name=Jane&email=jane%40example.com'
curl -sS -G 'https://{user}.{domain}/api/create_customer_by_api' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'user=value' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'subject=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_customer_by_api' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","user":"value","name":"Jane","email":"[email protected]","subject":"value","message":"Hey I am here","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Permenent Delete Doctor Appointment Api
This API endpoint allows for the permanent deletion of a doctor's appointment from the system. It's used when an appointment must be completely removed without any chance of recovery—typically for cleanup or correction tasks.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/permenent_delete_doctor_appointment_api
Your tenant: https://{user}.{domain}/api/permenent_delete_doctor_appointment_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/permenent_delete_doctor_appointment_api?token=YOUR_API_TOKEN&appointment_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/permenent_delete_doctor_appointment_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=permenent_delete_doctor_appointment_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
appointment_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/permenent_delete_doctor_appointment_api?token=YOUR_API_TOKEN&appointment_id=value
token => (Optional) – — appointment_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Permenent Delete Doctor Appointment Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=permenent_delete_doctor_appointment_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/permenent_delete_doctor_appointment_api?token=YOUR_API_TOKEN&appointment_id=value'
curl -sS -G 'https://{user}.{domain}/api/permenent_delete_doctor_appointment_api' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'appointment_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/permenent_delete_doctor_appointment_api' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","appointment_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Change Doctor Appointment Data API
This API endpoint allows you to modify an existing doctor’s appointment, updating its date and timing. It requires authentication and the specific appointment ID to apply changes accurately.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/change_doctor_appointment_data_api
Your tenant: https://{user}.{domain}/api/change_doctor_appointment_data_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/change_doctor_appointment_data_api?token=YOUR_API_TOKEN&appointment_id=value&start_time=value&end_time=value&date=2026-04-08 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/change_doctor_appointment_data_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=change_doctor_appointment_data_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
appointment_id | number | |
start_time | string | must set HH:MM format as we set default value |
end_time | string | must set HH:MM format as we set default value |
date | string | must set YYYY-MM-DD format as we set default value |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/change_doctor_appointment_data_api?token=YOUR_API_TOKEN&appointment_id=value&start_time=value&end_time=value&date=2026-04-08
token => (Optional) – — appointment_id => (Optional) – — start_time => (Required) – must set HH:MM format as we set default value end_time => (Required) – must set HH:MM format as we set default value date => (Required) – must set YYYY-MM-DD format as we set default value
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Change Doctor Appointment Data API
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=change_doctor_appointment_data_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/change_doctor_appointment_data_api?token=YOUR_API_TOKEN&appointment_id=value&start_time=value&end_time=value'
curl -sS -G 'https://{user}.{domain}/api/change_doctor_appointment_data_api' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'appointment_id=value' \
--data-urlencode 'start_time=value' \
--data-urlencode 'end_time=value' \
--data-urlencode 'date=2026-04-08'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/change_doctor_appointment_data_api' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","appointment_id":"value","start_time":"value","end_time":"value","date":"2026-04-08"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Doctor Appointment By Api
This API endpoint allows you to create a new doctor’s appointment directly in the system by specifying essential details like branch, customer, timing, date, and appointment type—all via a single API call.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_doctor_appointment_by_api
Your tenant: https://{user}.{domain}/api/create_doctor_appointment_by_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_doctor_appointment_by_api?token=YOUR_API_TOKEN&branch=value&cust_id=108545&start_time=value&end_time=value&date=2026-04-08&appointments_type_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_doctor_appointment_by_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_doctor_appointment_by_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
branch | string | |
cust_id | number | |
start_time | string | must set HH:MM format as we set default value |
end_time | string | must set HH:MM format as we set default value |
date | string | must set YYYY-MM-DD format as we set default value |
appointments_type_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_doctor_appointment_by_api?token=YOUR_API_TOKEN&branch=value&cust_id=108545&start_time=value&end_time=value&date=2026-04-08&appointments_type_id=value
token => (Optional) – — branch => (Optional) – — cust_id => (Optional) – — start_time => (Required) – must set HH:MM format as we set default value end_time => (Required) – must set HH:MM format as we set default value date => (Required) – must set YYYY-MM-DD format as we set default value appointments_type_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Doctor Appointment By Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_doctor_appointment_by_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_doctor_appointment_by_api?token=YOUR_API_TOKEN&branch=value&cust_id=108545&start_time=value'
curl -sS -G 'https://{user}.{domain}/api/create_doctor_appointment_by_api' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'branch=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'start_time=value' \
--data-urlencode 'end_time=value' \
--data-urlencode 'date=2026-04-08' \
--data-urlencode 'appointments_type_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_doctor_appointment_by_api' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","branch":"value","cust_id":"108545","start_time":"value","end_time":"value","date":"2026-04-08","appointments_type_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Template
This Api Retrieves a specific message or document template from the system based on the provided template_id. This is useful when you need the content, formatting, or settings of a particular predefined template.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_template
Your tenant: https://{user}.{domain}/api/get_template · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_template?token=YOUR_API_TOKEN&template_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_template) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_template instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
template_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_template?token=YOUR_API_TOKEN&template_id=value
token => (Optional) – — template_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Template
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_template.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_template?token=YOUR_API_TOKEN&template_id=value'
curl -sS -G 'https://{user}.{domain}/api/get_template' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'template_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_template' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","template_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Treatments
The get_treatments API is used to retrieve the list of available treatments or services configured in the system. Clients can use this endpoint to load and display the full catalog of treatment options (e.g., appointment types, services, procedures) for scheduling or presenting to users.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_treatments
Your tenant: https://{user}.{domain}/api/get_treatments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_treatments?token=YOUR_API_TOKEN — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_treatments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_treatments instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_treatments?token=YOUR_API_TOKEN
token => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Treatments
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_treatments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_treatments?token=YOUR_API_TOKEN'
curl -sS -G 'https://{user}.{domain}/api/get_treatments' \
--data-urlencode 'token=YOUR_API_TOKEN'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_treatments' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Appointment Booking List
The get_appointment_booking_list API retrieves a list of appointment bookings filtered by user or customer. It enables clients to fetch their own or related appointments for viewing or management.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_appointment_booking_list
Your tenant: https://{user}.{domain}/api/get_appointment_booking_list · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_appointment_booking_list?token=YOUR_API_TOKEN&user_id=14&cust_id=108545&booking_type=value&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_appointment_booking_list) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_appointment_booking_list instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
user_id | number | |
cust_id | number | |
booking_type | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_appointment_booking_list?token=YOUR_API_TOKEN&user_id=14&cust_id=108545&booking_type=value&phone=0500000000
token => (Optional) – — user_id => (Optional) – — cust_id => (Optional) – — booking_type => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Appointment Booking List
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_appointment_booking_list.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_appointment_booking_list?token=YOUR_API_TOKEN&user_id=14&cust_id=108545&booking_type=value'
curl -sS -G 'https://{user}.{domain}/api/get_appointment_booking_list' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'user_id=14' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'booking_type=value' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_appointment_booking_list' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","user_id":"14","cust_id":"108545","booking_type":"value","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Available Time Of Doctor
The get_available_time_of_doctor API retrieves available appointment slots for a specific branch and appointment type on a given date. It helps clients find suitable booking times based on the appointment duration and chosen branch.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_available_time_of_doctor
Your tenant: https://{user}.{domain}/api/get_available_time_of_doctor · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_available_time_of_doctor?token=YOUR_API_TOKEN&branch=value&appointment_type=value&data_time=value&date=2026-04-08 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_available_time_of_doctor) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_available_time_of_doctor instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
branch | string | |
appointment_type | string | |
data_time | string | |
date | string | must set YYYY-MM-DD format as we set default value |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_available_time_of_doctor?token=YOUR_API_TOKEN&branch=value&appointment_type=value&data_time=value&date=2026-04-08
token => (Optional) – — branch => (Optional) – — appointment_type => (Optional) – — data_time => (Optional) – — date => (Required) – must set YYYY-MM-DD format as we set default value
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Available Time Of Doctor
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_available_time_of_doctor.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_available_time_of_doctor?token=YOUR_API_TOKEN&branch=value&appointment_type=value&data_time=value'
curl -sS -G 'https://{user}.{domain}/api/get_available_time_of_doctor' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'branch=value' \
--data-urlencode 'appointment_type=value' \
--data-urlencode 'data_time=value' \
--data-urlencode 'date=2026-04-08'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_available_time_of_doctor' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","branch":"value","appointment_type":"value","data_time":"value","date":"2026-04-08"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Send Whatsapp Otp To Customer
The send_whatsapp_otp_to_customer API sends a one-time password (OTP) to a customer via WhatsApp. It requires authentication, identifies the sending user, and the recipient’s phone number to deliver the OTP message securely
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/send_whatsapp_otp_to_customer
Your tenant: https://{user}.{domain}/api/send_whatsapp_otp_to_customer · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/send_whatsapp_otp_to_customer?token=YOUR_API_TOKEN&user=value&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/send_whatsapp_otp_to_customer) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=send_whatsapp_otp_to_customer instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
user | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/send_whatsapp_otp_to_customer?token=YOUR_API_TOKEN&user=value&phone=0500000000
token => (Optional) – — user => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Send Whatsapp Otp To Customer
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=send_whatsapp_otp_to_customer.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/send_whatsapp_otp_to_customer?token=YOUR_API_TOKEN&user=value&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/send_whatsapp_otp_to_customer' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'user=value' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/send_whatsapp_otp_to_customer' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","user":"value","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Cancle Doctor Appointments
The cancle_doctor_appointments_api is used to cancel existing doctor appointments. It requires authentication and identifies the specific doctor and optionally filters by date, time, or patient phone to target which appointments to cancel.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/cancle_doctor_appointments
Your tenant: https://{user}.{domain}/api/cancle_doctor_appointments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/cancle_doctor_appointments?token=YOUR_API_TOKEN&doctor=value&date=value&start_time=value&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/cancle_doctor_appointments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=cancle_doctor_appointments instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
doctor | string | |
date | string | |
start_time | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/cancle_doctor_appointments?token=YOUR_API_TOKEN&doctor=value&date=value&start_time=value&phone=0500000000
token => (Optional) – — doctor => (Optional) – — date => (Optional) – — start_time => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Cancle Doctor Appointments
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=cancle_doctor_appointments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/cancle_doctor_appointments?token=YOUR_API_TOKEN&doctor=value&date=value&start_time=value'
curl -sS -G 'https://{user}.{domain}/api/cancle_doctor_appointments' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'doctor=value' \
--data-urlencode 'date=value' \
--data-urlencode 'start_time=value' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/cancle_doctor_appointments' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","doctor":"value","date":"value","start_time":"value","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Appointment (API)
The api_add_appointment API is used to add a detailed appointment record into the system with extensive scheduling, customer, payment, insurance, and room allocation data. It supports linking the appointment to specific doctors, branches, rooms, appointment types, and coupons while also handling insurance details, pricing, chat-related fields, and multi-day or group appointment configurations. This API is designed for complex booking scenarios where all aspects of the appointment lifecycle—creation, payment, insurance claims, status tracking, and communication—can be initialized in a single request.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/api_add_appointment
Your tenant: https://{user}.{domain}/api/api_add_appointment · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/api_add_appointment?token=YOUR_API_TOKEN&cust_id=108545&appointment_is_delete=value&cust_id_sec=108545&cust_name_sec=108545&data_time=value&doctor_appointment_for_cust_id=108545&appointment_group_id=value&all_ready_appo_add_or_not=value&data_grp_for_cust_id=108545&appointment_coupon_id=value&appointment_coupon_charge=value&appointment_left_coupon_charge=value&coupon_insurance_id_for_invoice=value&appointment_coupon_code_text=value&day_name=value&paid_status=value&cancel_status=value&selected_room_id=value&patient_name=value&company_id=value&insurance=value&phone=0500000000&email=jane%40example.com&customer_status=108545&customer_status_main_value=108545&gender=value&age=value¬es=value&default_doctor=value&koph=value&appointment_branch_id=value&insurance_cusotmer_price=value&appointments_type_data_id=value&appointment_room_id=value&doctor_id=value&case_number=value&balance=value&date=2026-04-08&referred_by=value&start_time=value&end_time=value&selected_document_type=value&same_appointment_day=value&appointment_manual_price=value&total_product_price=value&appo_name_chat=value&appo_id_chat=value&appointment_brance_id=value&chat_cust_id=108545&chat_message=value&user_id14=value&create_all_appo_same_time=value&add_same_appointment_multiple_day=value&cancle_appointment_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/api_add_appointment) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=api_add_appointment instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
cust_id | number | |
appointment_is_delete | string | |
cust_id_sec | string | |
cust_name_sec | string | |
data_time | string | |
doctor_appointment_for_cust_id | number | |
appointment_group_id | number | |
all_ready_appo_add_or_not | string | |
data_grp_for_cust_id | number | |
appointment_coupon_id | number | |
appointment_coupon_charge | string | |
appointment_left_coupon_charge | string | |
coupon_insurance_id_for_invoice | string | |
appointment_coupon_code_text | string | |
day_name | string | |
paid_status | string | |
cancel_status | string | |
selected_room_id | number | |
patient_name | string | |
company_id | number | |
insurance | string | |
phone | string | |
email | string | |
customer_status | string | |
customer_status_main_value | string | |
gender | string | |
age | string | |
notes | string | |
default_doctor | string | |
koph | string | |
appointment_branch_id | number | |
insurance_cusotmer_price | string | |
appointments_type_data_id | number | |
appointment_room_id | number | |
doctor_id | number | |
case_number | string | |
balance | string | |
date | string | must set YYYY-MM-DD format as we set default value |
referred_by | string | |
start_time | string | must set HH:MM format as we set default value |
end_time | string | must set HH:MM format as we set default value |
selected_document_type | string | |
same_appointment_day | string | |
appointment_manual_price | string | |
total_product_price | string | |
appo_name_chat | string | |
appo_id_chat | string | |
appointment_brance_id | number | |
chat_cust_id | number | |
chat_message | string | |
user_id14 | string | |
create_all_appo_same_time | string | |
add_same_appointment_multiple_day | string | |
cancle_appointment_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/api_add_appointment?token=YOUR_API_TOKEN&cust_id=108545&appointment_is_delete=value&cust_id_sec=108545&cust_name_sec=108545&data_time=value&doctor_appointment_for_cust_id=108545&appointment_group_id=value&all_ready_appo_add_or_not=value&data_grp_for_cust_id=108545&appointment_coupon_id=value&appointment_coupon_charge=value&appointment_left_coupon_charge=value&coupon_insurance_id_for_invoice=value&appointment_coupon_code_text=value&day_name=value&paid_status=value&cancel_status=value&selected_room_id=value&patient_name=value&company_id=value&insurance=value&phone=0500000000&email=jane%40example.com&customer_status=108545&customer_status_main_value=108545&gender=value&age=value¬es=value&default_doctor=value&koph=value&appointment_branch_id=value&insurance_cusotmer_price=value&appointments_type_data_id=value&appointment_room_id=value&doctor_id=value&case_number=value&balance=value&date=2026-04-08&referred_by=value&start_time=value&end_time=value&selected_document_type=value&same_appointment_day=value&appointment_manual_price=value&total_product_price=value&appo_name_chat=value&appo_id_chat=value&appointment_brance_id=value&chat_cust_id=108545&chat_message=value&user_id14=value&create_all_appo_same_time=value&add_same_appointment_multiple_day=value&cancle_appointment_id=value
token => (Optional) – — cust_id => (Optional) – — appointment_is_delete => (Optional) – — cust_id_sec => (Optional) – — cust_name_sec => (Optional) – — data_time => (Optional) – — doctor_appointment_for_cust_id => (Optional) – — appointment_group_id => (Optional) – — all_ready_appo_add_or_not => (Optional) – — data_grp_for_cust_id => (Optional) – — appointment_coupon_id => (Optional) – — appointment_coupon_charge => (Optional) – — appointment_left_coupon_charge => (Optional) – — coupon_insurance_id_for_invoice => (Optional) – — appointment_coupon_code_text => (Optional) – — day_name => (Optional) – — paid_status => (Optional) – — cancel_status => (Optional) – — selected_room_id => (Optional) – — patient_name => (Optional) – — company_id => (Optional) – — insurance => (Optional) – — phone => (Optional) – — email => (Required) – — customer_status => (Optional) – — customer_status_main_value => (Optional) – — gender => (Optional) – — age => (Optional) – — notes => (Optional) – — default_doctor => (Optional) – — koph => (Optional) – — appointment_branch_id => (Optional) – — insurance_cusotmer_price => (Optional) – — appointments_type_data_id => (Optional) – — appointment_room_id => (Optional) – — doctor_id => (Optional) – — case_number => (Optional) – — balance => (Optional) – — date => (Required) – must set YYYY-MM-DD format as we set default value referred_by => (Optional) – — start_time => (Required) – must set HH:MM format as we set default value end_time => (Required) – must set HH:MM format as we set default value selected_document_type => (Optional) – — same_appointment_day => (Optional) – — appointment_manual_price => (Optional) – — total_product_price => (Optional) – — appo_name_chat => (Optional) – — appo_id_chat => (Optional) – — appointment_brance_id => (Optional) – — chat_cust_id => (Optional) – — chat_message => (Optional) – — user_id14 => (Optional) – — create_all_appo_same_time => (Optional) – — add_same_appointment_multiple_day => (Optional) – — cancle_appointment_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Appointment (API)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=api_add_appointment.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/api_add_appointment?token=YOUR_API_TOKEN&cust_id=108545&appointment_is_delete=value&cust_id_sec=108545'
curl -sS -G 'https://{user}.{domain}/api/api_add_appointment' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'appointment_is_delete=value' \
--data-urlencode 'cust_id_sec=108545' \
--data-urlencode 'cust_name_sec=108545' \
--data-urlencode 'data_time=value' \
--data-urlencode 'doctor_appointment_for_cust_id=108545' \
--data-urlencode 'appointment_group_id=value' \
--data-urlencode 'all_ready_appo_add_or_not=value' \
--data-urlencode 'data_grp_for_cust_id=108545' \
--data-urlencode 'appointment_coupon_id=value' \
--data-urlencode 'appointment_coupon_charge=value' \
--data-urlencode 'appointment_left_coupon_charge=value' \
--data-urlencode 'coupon_insurance_id_for_invoice=value' \
--data-urlencode 'appointment_coupon_code_text=value' \
--data-urlencode 'day_name=value' \
--data-urlencode 'paid_status=value' \
--data-urlencode 'cancel_status=value' \
--data-urlencode 'selected_room_id=value' \
--data-urlencode 'patient_name=value' \
--data-urlencode 'company_id=value' \
--data-urlencode 'insurance=value' \
--data-urlencode 'phone=0500000000' \
--data-urlencode '[email protected]' \
--data-urlencode 'customer_status=108545' \
--data-urlencode 'customer_status_main_value=108545' \
--data-urlencode 'gender=value' \
--data-urlencode 'age=value' \
--data-urlencode 'notes=value' \
--data-urlencode 'default_doctor=value' \
--data-urlencode 'koph=value' \
--data-urlencode 'appointment_branch_id=value' \
--data-urlencode 'insurance_cusotmer_price=value' \
--data-urlencode 'appointments_type_data_id=value' \
--data-urlencode 'appointment_room_id=value' \
--data-urlencode 'doctor_id=value' \
--data-urlencode 'case_number=value' \
--data-urlencode 'balance=value' \
--data-urlencode 'date=2026-04-08' \
--data-urlencode 'referred_by=value' \
--data-urlencode 'start_time=value' \
--data-urlencode 'end_time=value' \
--data-urlencode 'selected_document_type=value' \
--data-urlencode 'same_appointment_day=value' \
--data-urlencode 'appointment_manual_price=value' \
--data-urlencode 'total_product_price=value' \
--data-urlencode 'appo_name_chat=value' \
--data-urlencode 'appo_id_chat=value' \
--data-urlencode 'appointment_brance_id=value' \
--data-urlencode 'chat_cust_id=108545' \
--data-urlencode 'chat_message=value' \
--data-urlencode 'user_id14=value' \
--data-urlencode 'create_all_appo_same_time=value' \
--data-urlencode 'add_same_appointment_multiple_day=value' \
--data-urlencode 'cancle_appointment_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/api_add_appointment' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","cust_id":"108545","appointment_is_delete":"value","cust_id_sec":"108545","cust_name_sec":"108545","data_time":"value","doctor_appointment_for_cust_id":"108545","appointment_group_id":"value","all_ready_appo_add_or_not":"value","data_grp_for_cust_id":"108545","appointment_coupon_id":"value","appointment_coupon_charge":"value","appointment_left_coupon_charge":"value","coupon_insurance_id_for_invoice":"value","appointment_coupon_code_text":"value","day_name":"value","paid_status":"value","cancel_status":"value","selected_room_id":"value","patient_name":"value","company_id":"value","insurance":"value","phone":"0500000000","email":"[email protected]","customer_status":"108545","customer_status_main_value":"108545","gender":"value","age":"value","notes":"value","default_doctor":"value","koph":"value","appointment_branch_id":"value","insurance_cusotmer_price":"value","appointments_type_data_id":"value","appointment_room_id":"value","doctor_id":"value","case_number":"value","balance":"value","date":"2026-04-08","referred_by":"value","start_time":"value","end_time":"value","selected_document_type":"value","same_appointment_day":"value","appointment_manual_price":"value","total_product_price":"value","appo_name_chat":"value","appo_id_chat":"value","appointment_brance_id":"value","chat_cust_id":"108545","chat_message":"value","user_id14":"value","create_all_appo_same_time":"value","add_same_appointment_multiple_day":"value","cancle_appointment_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Appointment
The add_appointment API is used to create and schedule a new appointment in the system. It records details such as the appointment date, time, doctor, client information, appointment type, and any additional notes. This API ensures the booking is registered with the specified doctor and categorized under the chosen appointment type for proper scheduling and record-keeping.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_appointment
Your tenant: https://{user}.{domain}/api/add_appointment · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_appointment?api_token=YOUR_API_TOKEN_FROM_SETTING&date=2026-04-08&doctor_id=value&name=Jane&email=jane%40example.com&mobile=0500000000&start_time=value&end_time=value&total_price=value¬es=value&subject=value&appointments_type_data_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_appointment) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_appointment instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
date | string | must set YYYY-MM-DD format as we set default value |
doctor_id | number | |
name | string | |
email | string | |
mobile | string | |
start_time | string | must set HH:MM format as we set default value |
end_time | string | must set HH:MM format as we set default value |
total_price | string | |
notes | string | |
subject | string | |
appointments_type_data_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_appointment?api_token=YOUR_API_TOKEN_FROM_SETTING&date=2026-04-08&doctor_id=value&name=Jane&email=jane%40example.com&mobile=0500000000&start_time=value&end_time=value&total_price=value¬es=value&subject=value&appointments_type_data_id=value
api_token => (Required) – — date => (Required) – must set YYYY-MM-DD format as we set default value doctor_id => (Optional) – — name => (Required) – — email => (Required) – — mobile => (Required) – — start_time => (Required) – must set HH:MM format as we set default value end_time => (Required) – must set HH:MM format as we set default value total_price => (Optional) – — notes => (Optional) – — subject => (Optional) – — appointments_type_data_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Appointment
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_appointment.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_appointment?api_token=YOUR_API_TOKEN_FROM_SETTING&date=2026-04-08&doctor_id=value&name=Jane'
curl -sS -G 'https://{user}.{domain}/api/add_appointment' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'date=2026-04-08' \
--data-urlencode 'doctor_id=value' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'mobile=0500000000' \
--data-urlencode 'start_time=value' \
--data-urlencode 'end_time=value' \
--data-urlencode 'total_price=value' \
--data-urlencode 'notes=value' \
--data-urlencode 'subject=value' \
--data-urlencode 'appointments_type_data_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_appointment' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","date":"2026-04-08","doctor_id":"value","name":"Jane","email":"[email protected]","mobile":"0500000000","start_time":"value","end_time":"value","total_price":"value","notes":"value","subject":"value","appointments_type_data_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Paytments ( paybridge Tranzila )
This API — add_paytments — records a payment transaction via the "paybridge_tranzila" payment gateway. It accepts authentication, identifies the user and customer, processes payment amount in a specific currency, and accepts product details for accurate processing and tracking.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_paytments
Your tenant: https://{user}.{domain}/api/add_paytments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&products=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_paytments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_paytments instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
user_id | number | |
payment_type | string | |
cust_id | number | |
amount | string | |
coin | string | |
products | string | JSON array containing purchased product details (item name, price, and quantity). |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&products=value
api_token => (Required) – — user_id => (Optional) – — payment_type => (Optional) – — cust_id => (Optional) – — amount => (Optional) – — coin => (Optional) – — products => (Required) – JSON array containing purchased product details (item name, price, and quantity).
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Paytments ( paybridge Tranzila )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_paytments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&payment_type=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/add_paytments' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'user_id=14' \
--data-urlencode 'payment_type=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'amount=value' \
--data-urlencode 'coin=value' \
--data-urlencode 'products=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_paytments' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","user_id":"14","payment_type":"value","cust_id":"108545","amount":"value","coin":"value","products":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Paytments ( payplus )
The add_paytments API records a customer payment within the system, capturing details such as the user initiating the payment, customer information, payment type, amount, currency, credit card details, subscription duration, and purchased product data for processing and record-keeping.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_paytments
Your tenant: https://{user}.{domain}/api/add_paytments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_paytments?user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value&cc_id=value&months=value&after=value&products=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_paytments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_paytments instead of the path segment.
| Name | Type | Description |
|---|---|---|
user_id | number | |
payment_type | string | |
cust_id | number | |
amount | string | |
coin | string | |
cc_num | string | |
cc_date | string | must set MM-YYYY format as we set default value |
cc_name | string | |
cc_cvc | string | |
cc_id | number | |
months | string | |
after | string | |
products | string | JSON array containing purchased product details (item name, price, and quantity). |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_paytments?user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value&cc_id=value&months=value&after=value&products=value
user_id => (Optional) – — payment_type => (Optional) – — cust_id => (Optional) – — amount => (Optional) – — coin => (Optional) – — cc_num => (Optional) – — cc_date => (Required) – must set MM-YYYY format as we set default value cc_name => (Optional) – — cc_cvc => (Optional) – — cc_id => (Optional) – — months => (Optional) – — after => (Optional) – — products => (Required) – JSON array containing purchased product details (item name, price, and quantity).
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Paytments ( payplus )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_paytments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_paytments?user_id=14&payment_type=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/add_paytments' \
--data-urlencode 'user_id=14' \
--data-urlencode 'payment_type=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'amount=value' \
--data-urlencode 'coin=value' \
--data-urlencode 'cc_num=value' \
--data-urlencode 'cc_date=value' \
--data-urlencode 'cc_name=value' \
--data-urlencode 'cc_cvc=value' \
--data-urlencode 'cc_id=value' \
--data-urlencode 'months=value' \
--data-urlencode 'after=value' \
--data-urlencode 'products=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_paytments' \
-H 'Content-Type: application/json' \
-d '{"user_id":"14","payment_type":"value","cust_id":"108545","amount":"value","coin":"value","cc_num":"value","cc_date":"value","cc_name":"value","cc_cvc":"value","cc_id":"value","months":"value","after":"value","products":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Paytments ( tranzilla )
The add_paytments API processes a direct payment by capturing essential transaction details such as payment type, amount, currency, and credit card information, using an authentication token for secure access.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_paytments
Your tenant: https://{user}.{domain}/api/add_paytments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&payment_type=value&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_paytments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_paytments instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
payment_type | string | |
amount | string | |
coin | string | |
cc_num | string | |
cc_date | string | must set MM-YYYY format as we set default value |
cc_name | string | |
cc_cvc | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&payment_type=value&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value
api_token => (Required) – — payment_type => (Optional) – — amount => (Optional) – — coin => (Optional) – — cc_num => (Optional) – — cc_date => (Required) – must set MM-YYYY format as we set default value cc_name => (Optional) – — cc_cvc => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Paytments ( tranzilla )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_paytments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_paytments?api_token=YOUR_API_TOKEN_FROM_SETTING&payment_type=value&amount=value&coin=value'
curl -sS -G 'https://{user}.{domain}/api/add_paytments' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'payment_type=value' \
--data-urlencode 'amount=value' \
--data-urlencode 'coin=value' \
--data-urlencode 'cc_num=value' \
--data-urlencode 'cc_date=value' \
--data-urlencode 'cc_name=value' \
--data-urlencode 'cc_cvc=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_paytments' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","payment_type":"value","amount":"value","coin":"value","cc_num":"value","cc_date":"value","cc_name":"value","cc_cvc":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Paytments ( credit card )
The add_paytments API records a payment for a customer, supporting both one-time and subscription transactions. It captures details such as payment type, amount, currency, credit card information, invoice creation options, subscription terms, and purchased products for processing and record-keeping.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_paytments
Your tenant: https://{user}.{domain}/api/add_paytments · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_paytments?user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value&cc_id=value&create_invoice=value&subscription=value&invoice_id=value&months=value&after=value&products=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_paytments) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_paytments instead of the path segment.
| Name | Type | Description |
|---|---|---|
user_id | number | |
payment_type | string | |
cust_id | number | |
amount | string | |
coin | string | |
cc_num | string | |
cc_date | string | must set MM-YYYY format as we set default value |
cc_name | string | |
cc_cvc | string | |
cc_id | number | |
create_invoice | string | |
subscription | string | |
invoice_id | number | |
months | string | |
after | string | |
products | string | JSON array containing purchased product details (item name, price, and quantity). |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_paytments?user_id=14&payment_type=value&cust_id=108545&amount=value&coin=value&cc_num=value&cc_date=value&cc_name=value&cc_cvc=value&cc_id=value&create_invoice=value&subscription=value&invoice_id=value&months=value&after=value&products=value
user_id => (Optional) – — payment_type => (Optional) – — cust_id => (Optional) – — amount => (Optional) – — coin => (Optional) – — cc_num => (Optional) – — cc_date => (Required) – must set MM-YYYY format as we set default value cc_name => (Optional) – — cc_cvc => (Optional) – — cc_id => (Optional) – — create_invoice => (Optional) – — subscription => (Optional) – — invoice_id => (Optional) – — months => (Optional) – — after => (Optional) – — products => (Required) – JSON array containing purchased product details (item name, price, and quantity).
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Paytments ( credit card )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_paytments.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_paytments?user_id=14&payment_type=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/add_paytments' \
--data-urlencode 'user_id=14' \
--data-urlencode 'payment_type=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'amount=value' \
--data-urlencode 'coin=value' \
--data-urlencode 'cc_num=value' \
--data-urlencode 'cc_date=value' \
--data-urlencode 'cc_name=value' \
--data-urlencode 'cc_cvc=value' \
--data-urlencode 'cc_id=value' \
--data-urlencode 'create_invoice=value' \
--data-urlencode 'subscription=value' \
--data-urlencode 'invoice_id=value' \
--data-urlencode 'months=value' \
--data-urlencode 'after=value' \
--data-urlencode 'products=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_paytments' \
-H 'Content-Type: application/json' \
-d '{"user_id":"14","payment_type":"value","cust_id":"108545","amount":"value","coin":"value","cc_num":"value","cc_date":"value","cc_name":"value","cc_cvc":"value","cc_id":"value","create_invoice":"value","subscription":"value","invoice_id":"value","months":"value","after":"value","products":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Download Mislaka Files Zip
The download_mislaka_files_zip API downloads all Mislaka files for a specific client as a ZIP archive, using authentication credentials and linking the files to a specific customer, user, and tab within the system.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/download_mislaka_files_zip
Your tenant: https://{user}.{domain}/api/download_mislaka_files_zip · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/download_mislaka_files_zip?auth=value&client_id=value&cust_id=108545&user_id=14&tab_id=value&tab_folder=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/download_mislaka_files_zip) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=download_mislaka_files_zip instead of the path segment.
| Name | Type | Description |
|---|---|---|
auth | string | |
client_id | number | |
cust_id | number | |
user_id | number | |
tab_id | number | |
tab_folder | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/download_mislaka_files_zip?auth=value&client_id=value&cust_id=108545&user_id=14&tab_id=value&tab_folder=value
auth => (Optional) – — client_id => (Optional) – — cust_id => (Optional) – — user_id => (Optional) – — tab_id => (Optional) – — tab_folder => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Download Mislaka Files Zip
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=download_mislaka_files_zip.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/download_mislaka_files_zip?auth=value&client_id=value&cust_id=108545'
curl -sS -G 'https://{user}.{domain}/api/download_mislaka_files_zip' \
--data-urlencode 'auth=value' \
--data-urlencode 'client_id=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'user_id=14' \
--data-urlencode 'tab_id=value' \
--data-urlencode 'tab_folder=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/download_mislaka_files_zip' \
-H 'Content-Type: application/json' \
-d '{"auth":"value","client_id":"value","cust_id":"108545","user_id":"14","tab_id":"value","tab_folder":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Mislaka For Client
The get_mislaka_for_client API retrieves Mislaka (government portal) data associated with a specific client in the Polywizz system, using the client’s unique ID and authentication credentials for access.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_mislaka_for_client
Your tenant: https://{user}.{domain}/api/get_mislaka_for_client · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_mislaka_for_client?auth=value&client_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_mislaka_for_client) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_mislaka_for_client instead of the path segment.
| Name | Type | Description |
|---|---|---|
auth | string | |
client_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_mislaka_for_client?auth=value&client_id=value
auth => (Optional) – — client_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Mislaka For Client
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_mislaka_for_client.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_mislaka_for_client?auth=value&client_id=value'
curl -sS -G 'https://{user}.{domain}/api/get_mislaka_for_client' \
--data-urlencode 'auth=value' \
--data-urlencode 'client_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_mislaka_for_client' \
-H 'Content-Type: application/json' \
-d '{"auth":"value","client_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Har Data
The get_har_data API retrieves Har insurance task data for a specific client from the Polywizz system. It uses the client ID and task ID to identify the record, along with authentication and optional parameters to control credential usage and link the data to a specific user, customer, and tab in the system.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_har_data
Your tenant: https://{user}.{domain}/api/get_har_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_har_data?client_id=value&task_id=value&auth=value&use_agent_credentials=value&user_id=14&cust_id=108545&tab_id=value&tab_folder=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_har_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_har_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
client_id | number | |
task_id | number | |
auth | string | |
use_agent_credentials | string | |
user_id | number | |
cust_id | number | |
tab_id | number | |
tab_folder | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_har_data?client_id=value&task_id=value&auth=value&use_agent_credentials=value&user_id=14&cust_id=108545&tab_id=value&tab_folder=value
client_id => (Optional) – — task_id => (Optional) – — auth => (Optional) – — use_agent_credentials => (Optional) – — user_id => (Optional) – — cust_id => (Optional) – — tab_id => (Optional) – — tab_folder => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Har Data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_har_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_har_data?client_id=value&task_id=value&auth=value'
curl -sS -G 'https://{user}.{domain}/api/get_har_data' \
--data-urlencode 'client_id=value' \
--data-urlencode 'task_id=value' \
--data-urlencode 'auth=value' \
--data-urlencode 'use_agent_credentials=value' \
--data-urlencode 'user_id=14' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'tab_id=value' \
--data-urlencode 'tab_folder=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_har_data' \
-H 'Content-Type: application/json' \
-d '{"client_id":"value","task_id":"value","auth":"value","use_agent_credentials":"value","user_id":"14","cust_id":"108545","tab_id":"value","tab_folder":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Har Insurance Task
The create_har_insurance_task endpoint streamlines the creation of insurance tasks using a flexible approach to credentials—either fresh user inputs or existing agent credentials. This enables streamlined admin workflows and seamless task initiation.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_har_insurance_task
Your tenant: https://{user}.{domain}/api/create_har_insurance_task · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_har_insurance_task?auth=value&client_id=value&gov_user=value&gov_password=value&save_credentials=value&use_agent_credentials=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_har_insurance_task) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_har_insurance_task instead of the path segment.
| Name | Type | Description |
|---|---|---|
auth | string | |
client_id | number | |
gov_user | string | |
gov_password | string | |
save_credentials | string | |
use_agent_credentials | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_har_insurance_task?auth=value&client_id=value&gov_user=value&gov_password=value&save_credentials=value&use_agent_credentials=value
auth => (Optional) – — client_id => (Optional) – — gov_user => (Optional) – — gov_password => (Optional) – — save_credentials => (Optional) – — use_agent_credentials => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Har Insurance Task
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_har_insurance_task.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_har_insurance_task?auth=value&client_id=value&gov_user=value'
curl -sS -G 'https://{user}.{domain}/api/create_har_insurance_task' \
--data-urlencode 'auth=value' \
--data-urlencode 'client_id=value' \
--data-urlencode 'gov_user=value' \
--data-urlencode 'gov_password=value' \
--data-urlencode 'save_credentials=value' \
--data-urlencode 'use_agent_credentials=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_har_insurance_task' \
-H 'Content-Type: application/json' \
-d '{"auth":"value","client_id":"value","gov_user":"value","gov_password":"value","save_credentials":"value","use_agent_credentials":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Client
This Api Used to Creates a new client record in the Polywizz system by sending personal and identification details.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_client
Your tenant: https://{user}.{domain}/api/create_client · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_client?auth=value&first_name=value&last_name=value&phone=0500000000&id_number=value&id_issuing_date=2026-04-08&birthday_date=2026-04-08 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_client) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_client instead of the path segment.
| Name | Type | Description |
|---|---|---|
auth | string | |
first_name | string | |
last_name | string | |
phone | string | |
id_number | string | |
id_issuing_date | string | must set YYYY-MM-DD format as we set default value |
birthday_date | string | must set YYYY-MM-DD format as we set default value |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_client?auth=value&first_name=value&last_name=value&phone=0500000000&id_number=value&id_issuing_date=2026-04-08&birthday_date=2026-04-08
auth => (Optional) – — first_name => (Optional) – — last_name => (Optional) – — phone => (Optional) – — id_number => (Optional) – — id_issuing_date => (Required) – must set YYYY-MM-DD format as we set default value birthday_date => (Required) – must set YYYY-MM-DD format as we set default value
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Client
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_client.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_client?auth=value&first_name=value&last_name=value'
curl -sS -G 'https://{user}.{domain}/api/create_client' \
--data-urlencode 'auth=value' \
--data-urlencode 'first_name=value' \
--data-urlencode 'last_name=value' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'id_number=value' \
--data-urlencode 'id_issuing_date=2026-04-08' \
--data-urlencode 'birthday_date=2026-04-08'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_client' \
-H 'Content-Type: application/json' \
-d '{"auth":"value","first_name":"value","last_name":"value","phone":"0500000000","id_number":"value","id_issuing_date":"2026-04-08","birthday_date":"2026-04-08"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Document ( Api 2all )
The 2all API enables seamless integration between external sales channels and the 2all system by pushing complete order data. This includes customer details, product line items, shipping information, payment status, and pricing. It is designed to ensure that orders created in third-party platforms are accurately recorded and managed within 2all without manual entry.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/api_2all
Your tenant: https://{user}.{domain}/api/api_2all · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/api_2all?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&0=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/api_2all) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=api_2all instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
customer_id | number | |
0 | string | { "RowID": "15813404", // optional "OrderNumber": "92020", "EmailAddress": " [email protected] ", // required "CustomerLastName": "margi", // required "CustomerFirstName": "test", // required "InvoiceCompanyName": "", // optional "Address": "test address", // required "City": "test city", // required "SpecialDeliveryCountriesText": "test special delivery countries text", // optional "Remarks": "test remarks", // optional "ZipCode": "test zip code", // optional "PhoneNumber1": "919909279618", // required "PhoneNumber2": "919909279618", // required "Currency": "1", // optional "TotalPrice": "94", // optional "PaymentType": "1", // optional "PaymentTypeDesc": "", // optional "PaymentTypeDate": "", // optional "PaymentTypeStatus": "\u05dc\u05d0 \u05e9\u05d5\u05dc\u05dd", // rerequired "Shipping": "50", // optional "ShippingType": "1", // optional "ShippingDesc": "test shipping desc", // optional "ShippingCompany": "0", // optional "ShippingMethod": "test shipping method", // optional "ShippingPoint": "test shipping point", // optional "ShippingPointText": "test shipping point text", // optional "TotalPriceBeforeTaxAndShipping": "44", // optional "TotalPriceAfterTaxAndShipping": "94", // optional "IsFinishedPaymentActionsDate": "2024-01-09 00:37:35", // optional "IsConfirmedReceivingMailing": "0", // optional "CreateDate": "2024-01-09 00:37:35", // optional "CRM_OrderStatusRowID": "", // optional "CRM_StatusDesc": "", // optional "IPN_Payment_Type": "", // optional "IPN_Payment_CardName": "", // optional "TransactionID": "", // optional "items": [ { "RowType": "0",// optional "Description": "test description", // required "ProductPicLink": "test product pic link", // optional "ProductLink": "test product link", // optional "CatalogNumber": "test catalog number", // required "UnitPrice": "44", // required "PicID": "465029", // optional "Quantity": "1" // required }, { "RowType": "1",// optional "Description": "test description", // required "ProductPicLink": "test product pic link", // optional "ProductLink": "test product link", // optional "CatalogNumber": "test catalog number", // required "UnitPrice": "50", // required "PicID": "0", // optional "Quantity": "1" // required } ] // required } |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/api_2all?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&0=value
api_token => (Required) – —
customer_id => (Optional) – —
0 => (Optional) – { "RowID": "15813404", // optional "OrderNumber": "92020", "EmailAddress": " [email protected] ", // required "CustomerLastName": "margi", // required "CustomerFirstName": "test", // required "InvoiceCompanyName": "", // optional "Address": "test address", // required "City": "test city", // required "SpecialDeliveryCountriesText": "test special delivery countries text", // optional "Remarks": "test remarks", // optional "ZipCode": "test zip code", // optional "PhoneNumber1": "919909279618", // required "PhoneNumber2": "919909279618", // required "Currency": "1", // optional "TotalPrice": "94", // optional "PaymentType": "1", // optional "PaymentTypeDesc": "", // optional "PaymentTypeDate": "", // optional "PaymentTypeStatus": "\u05dc\u05d0 \u05e9\u05d5\u05dc\u05dd", // rerequired "Shipping": "50", // optional "ShippingType": "1", // optional "ShippingDesc": "test shipping desc", // optional "ShippingCompany": "0", // optional "ShippingMethod": "test shipping method", // optional "ShippingPoint": "test shipping point", // optional "ShippingPointText": "test shipping point text", // optional "TotalPriceBeforeTaxAndShipping": "44", // optional "TotalPriceAfterTaxAndShipping": "94", // optional "IsFinishedPaymentActionsDate": "2024-01-09 00:37:35", // optional "IsConfirmedReceivingMailing": "0", // optional "CreateDate": "2024-01-09 00:37:35", // optional "CRM_OrderStatusRowID": "", // optional "CRM_StatusDesc": "", // optional "IPN_Payment_Type": "", // optional "IPN_Payment_CardName": "", // optional "TransactionID": "", // optional "items": [ { "RowType": "0",// optional "Description": "test description", // required "ProductPicLink": "test product pic link", // optional "ProductLink": "test product link", // optional "CatalogNumber": "test catalog number", // required "UnitPrice": "44", // required "PicID": "465029", // optional "Quantity": "1" // required }, { "RowType": "1",// optional "Description": "test description", // required "ProductPicLink": "test product pic link", // optional "ProductLink": "test product link", // optional "CatalogNumber": "test catalog number", // required "UnitPrice": "50", // required "PicID": "0", // optional "Quantity": "1" // required } ] // required }
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Document ( Api 2all )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=api_2all.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/api_2all?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&0=value'
curl -sS -G 'https://{user}.{domain}/api/api_2all' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'customer_id=108545' \
--data-urlencode '0=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/api_2all' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","customer_id":"108545","0":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Recording (ani,did,etc include)
The Add Recording API is used to store call recording details in the system for a specific client or phone number. By providing the user’s authentication token, client ID, call type (incoming or outgoing), and optionally details such as phone number, notes, message, duration, answer status, and recording URL, this API logs and associates the call information with the relevant user record. It helps maintain a detailed call history, including recordings and related metadata, for tracking and reference purposes
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_recording
Your tenant: https://{user}.{domain}/api/add_recording · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_recording?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&mobile=0500000000&recording_url=value&type=value¬e=value&duration=value&answerd=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_recording) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_recording instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
cust_id | number | |
mobile | string | |
recording_url | string | |
type | string | |
note | string | |
duration | string | |
answerd | string | Whether the call was answered (1 = yes, 0 = no). Default: 1. |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_recording?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&mobile=0500000000&recording_url=value&type=value¬e=value&duration=value&answerd=value
api_token => (Required) – — cust_id => (Optional) – — mobile => (Required) – — recording_url => (Optional) – — type => (Optional) – — note => (Optional) – — duration => (Optional) – — answerd => (Required) – Whether the call was answered (1 = yes, 0 = no). Default: 1.
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Recording (ani,did,etc include)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_recording.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_recording?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&mobile=0500000000&recording_url=value'
curl -sS -G 'https://{user}.{domain}/api/add_recording' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'mobile=0500000000' \
--data-urlencode 'recording_url=value' \
--data-urlencode 'type=value' \
--data-urlencode 'note=value' \
--data-urlencode 'duration=value' \
--data-urlencode 'answerd=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_recording' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545","mobile":"0500000000","recording_url":"value","type":"value","note":"value","duration":"value","answerd":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Sendmail With Template
This API sends an email using a specified template or custom content. It allows specifying the recipient, subject, message, and optional user or SMTP settings.
GET / POST · Product list may show POST only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/sendmail_with_template
Your tenant: https://{user}.{domain}/api/sendmail_with_template · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/sendmail_with_template?user_id=14&api_token=YOUR_API_TOKEN_FROM_SETTING&to=value&message=Hey%20I%20am%20here&subject=value&attach=value&smtp_id=value&attach_path=value&attachment_name=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/sendmail_with_template) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=sendmail_with_template instead of the path segment.
| Name | Type | Description |
|---|---|---|
user_id | number | |
api_token | string | |
to | string | |
message | string | |
subject | string | |
attach | string | |
smtp_id | number | |
attach_path | string | |
attachment_name | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/sendmail_with_template?user_id=14&api_token=YOUR_API_TOKEN_FROM_SETTING&to=value&message=Hey%20I%20am%20here&subject=value&attach=value&smtp_id=value&attach_path=value&attachment_name=value
user_id => (Optional) – — api_token => (Required) – — to => (Optional) – — message => (Optional) – — subject => (Optional) – — attach => (Optional) – — smtp_id => (Optional) – — attach_path => (Optional) – — attachment_name => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Sendmail With Template
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=sendmail_with_template.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/sendmail_with_template?api_token=YOUR_API_TOKEN_FROM_SETTING&user_id=14&to=value&message=Hey%20I%20am%20here'
curl -sS -G 'https://{user}.{domain}/api/sendmail_with_template' \
--data-urlencode 'user_id=14' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'to=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'subject=value' \
--data-urlencode 'attach=value' \
--data-urlencode 'smtp_id=value' \
--data-urlencode 'attach_path=value' \
--data-urlencode 'attachment_name=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/sendmail_with_template' \
-H 'Content-Type: application/json' \
-d '{"user_id":"14","api_token":"YOUR_API_TOKEN_FROM_SETTING","to":"value","message":"Hey I am here","subject":"value","attach":"value","smtp_id":"value","attach_path":"value","attachment_name":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Order Wp ( Using POST )
This API creates a new order by capturing customer billing and shipping details, products purchased, shipping method, taxes, fees, coupons, and additional metadata, enabling order processing and record-keeping in the WooCommerce system.
GET / POST · Product list may show POST only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order_wp
Your tenant: https://{user}.{domain}/api/add_order_wp · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order_wp?api_token=YOUR_API_TOKEN_FROM_SETTING&billing=value&shipping=value&line_items=value&tax_lines=value&shipping_lines=value&fee_lines=value&coupon_lines=value&meta_data=value&refunds=value&_links=value&source=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order_wp) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order_wp instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
billing | string | |
shipping | string | |
line_items | string | |
tax_lines | string | |
shipping_lines | string | |
fee_lines | string | |
coupon_lines | string | |
meta_data | string | |
refunds | string | |
_links | string | |
source | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order_wp?api_token=YOUR_API_TOKEN_FROM_SETTING&billing=value&shipping=value&line_items=value&tax_lines=value&shipping_lines=value&fee_lines=value&coupon_lines=value&meta_data=value&refunds=value&_links=value&source=value
api_token => (Required) – — billing => (Optional) – — shipping => (Optional) – — line_items => (Optional) – — tax_lines => (Optional) – — shipping_lines => (Optional) – — fee_lines => (Optional) – — coupon_lines => (Optional) – — meta_data => (Optional) – — refunds => (Optional) – — _links => (Optional) – — source => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Order Wp ( Using POST )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order_wp.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order_wp?api_token=YOUR_API_TOKEN_FROM_SETTING&billing=value&shipping=value&line_items=value'
curl -sS -G 'https://{user}.{domain}/api/add_order_wp' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'billing=value' \
--data-urlencode 'shipping=value' \
--data-urlencode 'line_items=value' \
--data-urlencode 'tax_lines=value' \
--data-urlencode 'shipping_lines=value' \
--data-urlencode 'fee_lines=value' \
--data-urlencode 'coupon_lines=value' \
--data-urlencode 'meta_data=value' \
--data-urlencode 'refunds=value' \
--data-urlencode '_links=value' \
--data-urlencode 'source=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order_wp' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","billing":"value","shipping":"value","line_items":"value","tax_lines":"value","shipping_lines":"value","fee_lines":"value","coupon_lines":"value","meta_data":"value","refunds":"value","_links":"value","source":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Konimbo ( Using POST )
This Api Creates a new order by capturing customer details, shipping and billing information, products purchased, payment method, and related metadata for processing and record-keeping.
GET / POST · Product list may show POST only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/konimbo
Your tenant: https://{user}.{domain}/api/konimbo · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value&paid=value&reciept_tax_invoice=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/konimbo) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=konimbo instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
customer | string | |
order | object (JSON) | |
team_member_id | number | |
paid | string | |
reciept_tax_invoice | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value&paid=value&reciept_tax_invoice=value
api_token => (Required) – — customer => (Optional) – — order => (Optional) – — team_member_id => (Optional) – — paid => (Optional) – — reciept_tax_invoice => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Konimbo ( Using POST )
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=konimbo.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value'
curl -sS -G 'https://{user}.{domain}/api/konimbo' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'customer=108545' \
--data-urlencode 'order=value' \
--data-urlencode 'team_member_id=value' \
--data-urlencode 'paid=value' \
--data-urlencode 'reciept_tax_invoice=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/konimbo' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","customer":"108545","order":"value","team_member_id":"value","paid":"value","reciept_tax_invoice":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Konimbo
This Api Creates a new order by capturing customer details, shipping and billing information, products purchased, payment method, and related metadata for processing and record-keeping.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/konimbo
Your tenant: https://{user}.{domain}/api/konimbo · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value&paid=value&reciept_tax_invoice=value&source=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/konimbo) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=konimbo instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
customer | string | |
order | object (JSON) | |
team_member_id | number | |
paid | string | |
reciept_tax_invoice | string | |
source | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value&paid=value&reciept_tax_invoice=value&source=value
api_token => (Required) – — customer => (Optional) – — order => (Optional) – — team_member_id => (Optional) – — paid => (Optional) – — reciept_tax_invoice => (Optional) – — source => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Konimbo
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=konimbo.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/konimbo?api_token=YOUR_API_TOKEN_FROM_SETTING&customer=108545&order=value&team_member_id=value'
curl -sS -G 'https://{user}.{domain}/api/konimbo' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'customer=108545' \
--data-urlencode 'order=value' \
--data-urlencode 'team_member_id=value' \
--data-urlencode 'paid=value' \
--data-urlencode 'reciept_tax_invoice=value' \
--data-urlencode 'source=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/konimbo' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","customer":"108545","order":"value","team_member_id":"value","paid":"value","reciept_tax_invoice":"value","source":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add ticket
This Api used to Creates a new support ticket in the system with customer details, department assignment, urgency level, and the message content. This is used for submitting customer issues, inquiries, or requests to the support team for follow-up and resolution.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_ticket
Your tenant: https://{user}.{domain}/api/add_ticket · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_ticket?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&department=value&urgency=value&message=Hey%20I%20am%20here&subject=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_ticket) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_ticket instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
department | string | |
urgency | string | |
message | string | |
subject | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_ticket?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&department=value&urgency=value&message=Hey%20I%20am%20here&subject=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — department => (Optional) – — urgency => (Optional) – — message => (Optional) – — subject => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add ticket
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_ticket.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_ticket?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_ticket' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'department=value' \
--data-urlencode 'urgency=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'subject=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_ticket' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","department":"value","urgency":"value","message":"Hey I am here","subject":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Order
Creates a new order in the system with provided shipping details, billing details, payment method, ordered items, currency, and tax information. The API accepts structured JSON data for addresses and line items, enabling accurate recording of customer and product information for further processing.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/create_order
Your tenant: https://{user}.{domain}/api/create_order · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/create_order?api_token=YOUR_API_TOKEN_FROM_SETTING&lang=value&shipping=value&billing=value&payment_method=value&line_items=value¤cy=value&cart_tax=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/create_order) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=create_order instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
lang | string | |
shipping | string | |
billing | string | |
payment_method | string | |
line_items | string | |
currency | string | |
cart_tax | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/create_order?api_token=YOUR_API_TOKEN_FROM_SETTING&lang=value&shipping=value&billing=value&payment_method=value&line_items=value¤cy=value&cart_tax=value
api_token => (Required) – — lang => (Optional) – — shipping => (Optional) – — billing => (Optional) – — payment_method => (Optional) – — line_items => (Optional) – — currency => (Optional) – — cart_tax => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Order
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=create_order.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/create_order?api_token=YOUR_API_TOKEN_FROM_SETTING&lang=value&shipping=value&billing=value'
curl -sS -G 'https://{user}.{domain}/api/create_order' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'lang=value' \
--data-urlencode 'shipping=value' \
--data-urlencode 'billing=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'line_items=value' \
--data-urlencode 'currency=value' \
--data-urlencode 'cart_tax=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/create_order' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","lang":"value","shipping":"value","billing":"value","payment_method":"value","line_items":"value","currency":"value","cart_tax":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Call Link Testing
This Api Handles call link Send call data to the system, log recordings, trigger notifications, and optionally create missions for unanswered calls.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/call_link_testing
Your tenant: https://{user}.{domain}/api/call_link_testing · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/call_link_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&call_to=value&today=value&doc=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/call_link_testing) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=call_link_testing instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
source | string | |
destination | string | |
direction | string | |
ani | string | |
duration | string | |
did | string | |
result | string | |
domain | string | |
recording | string | |
org | string | |
call_to | string | |
today | string | must set Y-m-d H:i:s formate as we set default value |
doc | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/call_link_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&call_to=value&today=value&doc=value
token => (Optional) – — source => (Optional) – — destination => (Optional) – — direction => (Optional) – — ani => (Optional) – — duration => (Optional) – — did => (Optional) – — result => (Optional) – — domain => (Optional) – — recording => (Optional) – — org => (Optional) – — call_to => (Optional) – — today => (Required) – must set Y-m-d H:i:s formate as we set default value doc => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Call Link Testing
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=call_link_testing.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/call_link_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value'
curl -sS -G 'https://{user}.{domain}/api/call_link_testing' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'source=value' \
--data-urlencode 'destination=value' \
--data-urlencode 'direction=value' \
--data-urlencode 'ani=value' \
--data-urlencode 'duration=value' \
--data-urlencode 'did=value' \
--data-urlencode 'result=value' \
--data-urlencode 'domain=value' \
--data-urlencode 'recording=value' \
--data-urlencode 'org=value' \
--data-urlencode 'call_to=value' \
--data-urlencode 'today=value' \
--data-urlencode 'doc=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/call_link_testing' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","source":"value","destination":"value","direction":"value","ani":"value","duration":"value","did":"value","result":"value","domain":"value","recording":"value","org":"value","call_to":"value","today":"value","doc":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Call Testing
This Api used Logs a test call event with details including source, destination, direction, duration, call status, and query results. Includes metadata such as domain, organization, IVR name, and recording information.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/call_testing
Your tenant: https://{user}.{domain}/api/call_testing · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/call_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&query=value&result=value&domain=value&recording=value&org=value&ivr_name=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/call_testing) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=call_testing instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
source | string | |
destination | string | |
direction | string | |
ani | string | |
duration | string | |
did | string | |
query | string | |
result | string | |
domain | string | |
recording | string | |
org | string | |
ivr_name | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/call_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&query=value&result=value&domain=value&recording=value&org=value&ivr_name=value
token => (Optional) – — source => (Optional) – — destination => (Optional) – — direction => (Optional) – — ani => (Optional) – — duration => (Optional) – — did => (Optional) – — query => (Optional) – — result => (Optional) – — domain => (Optional) – — recording => (Optional) – — org => (Optional) – — ivr_name => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Call Testing
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=call_testing.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/call_testing?token=YOUR_API_TOKEN&source=value&destination=value&direction=value'
curl -sS -G 'https://{user}.{domain}/api/call_testing' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'source=value' \
--data-urlencode 'destination=value' \
--data-urlencode 'direction=value' \
--data-urlencode 'ani=value' \
--data-urlencode 'duration=value' \
--data-urlencode 'did=value' \
--data-urlencode 'query=value' \
--data-urlencode 'result=value' \
--data-urlencode 'domain=value' \
--data-urlencode 'recording=value' \
--data-urlencode 'org=value' \
--data-urlencode 'ivr_name=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/call_testing' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","source":"value","destination":"value","direction":"value","ani":"value","duration":"value","did":"value","query":"value","result":"value","domain":"value","recording":"value","org":"value","ivr_name":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Call (Outgoing call)
This Api Retrives Logs an outbound call event with details such as source, destination, call direction, duration, result, and associated metadata like recording, organization, and IVR information. Used for maintaining call history and tracking call performance.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/call
Your tenant: https://{user}.{domain}/api/call · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&ivr_name=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/call) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=call instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
source | string | |
destination | string | |
direction | string | direction = out_call |
ani | string | |
duration | string | |
did | string | |
result | string | |
domain | string | |
recording | string | |
org | string | |
ivr_name | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&ivr_name=value
token => (Optional) – — source => (Optional) – — destination => (Optional) – — direction => (Required) – direction = out_call ani => (Optional) – — duration => (Optional) – — did => (Optional) – — result => (Optional) – — domain => (Optional) – — recording => (Optional) – — org => (Optional) – — ivr_name => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Call (Outgoing call)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=call.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value'
curl -sS -G 'https://{user}.{domain}/api/call' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'source=value' \
--data-urlencode 'destination=value' \
--data-urlencode 'direction=value' \
--data-urlencode 'ani=value' \
--data-urlencode 'duration=value' \
--data-urlencode 'did=value' \
--data-urlencode 'result=value' \
--data-urlencode 'domain=value' \
--data-urlencode 'recording=value' \
--data-urlencode 'org=value' \
--data-urlencode 'ivr_name=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/call' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","source":"value","destination":"value","direction":"value","ani":"value","duration":"value","did":"value","result":"value","domain":"value","recording":"value","org":"value","ivr_name":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Call (In call)
This Api Retrives Records detailed information about in call, including source, destination, direction, duration, status, and any associated recording or metadata, for call tracking and reporting purposes.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/call
Your tenant: https://{user}.{domain}/api/call · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&ivr_name=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/call) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=call instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
source | string | |
destination | string | |
direction | string | direction = in_call |
ani | string | |
duration | string | |
did | string | |
result | string | |
domain | string | |
recording | string | |
org | string | |
ivr_name | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value&ani=value&duration=value&did=value&result=value&domain=value&recording=value&org=value&ivr_name=value
token => (Optional) – — source => (Optional) – — destination => (Optional) – — direction => (Required) – direction = in_call ani => (Optional) – — duration => (Optional) – — did => (Optional) – — result => (Optional) – — domain => (Optional) – — recording => (Optional) – — org => (Optional) – — ivr_name => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Call (In call)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=call.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/call?token=YOUR_API_TOKEN&source=value&destination=value&direction=value'
curl -sS -G 'https://{user}.{domain}/api/call' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'source=value' \
--data-urlencode 'destination=value' \
--data-urlencode 'direction=value' \
--data-urlencode 'ani=value' \
--data-urlencode 'duration=value' \
--data-urlencode 'did=value' \
--data-urlencode 'result=value' \
--data-urlencode 'domain=value' \
--data-urlencode 'recording=value' \
--data-urlencode 'org=value' \
--data-urlencode 'ivr_name=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/call' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","source":"value","destination":"value","direction":"value","ani":"value","duration":"value","did":"value","result":"value","domain":"value","recording":"value","org":"value","ivr_name":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Order
Creates a new order in the system for a specified customer, including order details, products, and optional payment information. Requires a valid API token for authorization.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order
Your tenant: https://{user}.{domain}/api/add_order · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&lang=value&order=value&products=value&transfert_note=value&ch_note=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&unlimited=value&test_card=value&payment_date=2026-04-08&number_of_payments=value&cash_note=value&id=value&status=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
lang | string | |
order | object (JSON) | |
products | string | |
transfert_note | string | |
ch_note | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
unlimited | string | |
test_card | string | |
payment_date | string | must set YYYY-MM-DD format as we set default value |
number_of_payments | string | |
cash_note | string | |
id | string | |
status | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&lang=value&order=value&products=value&transfert_note=value&ch_note=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&unlimited=value&test_card=value&payment_date=2026-04-08&number_of_payments=value&cash_note=value&id=value&status=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — lang => (Optional) – — order => (Optional) – — products => (Optional) – — transfert_note => (Optional) – — ch_note => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — unlimited => (Optional) – — test_card => (Optional) – — payment_date => (Required) – must set YYYY-MM-DD format as we set default value number_of_payments => (Optional) – — cash_note => (Optional) – — id => (Optional) – — status => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Order
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'lang=value' \
--data-urlencode 'order=value' \
--data-urlencode 'products=value' \
--data-urlencode 'transfert_note=value' \
--data-urlencode 'ch_note=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'unlimited=value' \
--data-urlencode 'test_card=value' \
--data-urlencode 'payment_date=2026-04-08' \
--data-urlencode 'number_of_payments=value' \
--data-urlencode 'cash_note=value' \
--data-urlencode 'id=value' \
--data-urlencode 'status=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","lang":"value","order":"value","products":"value","transfert_note":"value","ch_note":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","unlimited":"value","test_card":"value","payment_date":"2026-04-08","number_of_payments":"value","cash_note":"value","id":"value","status":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Extra Fields
This API checks the user’s stored information and outputs the value of the extra_fields column from the user_detail table. It Returns the extra_fields data associated with the authenticated user.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_extra_fields
Your tenant: https://{user}.{domain}/api/get_extra_fields · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_extra_fields?api_token=YOUR_API_TOKEN_FROM_SETTING — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_extra_fields) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_extra_fields instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_extra_fields?api_token=YOUR_API_TOKEN_FROM_SETTING
api_token => (Required) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Extra Fields
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_extra_fields.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_extra_fields?api_token=YOUR_API_TOKEN_FROM_SETTING'
curl -sS -G 'https://{user}.{domain}/api/get_extra_fields' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_extra_fields' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Stop automation
Thsi Api used Stops a specific automation process for the given customer. Requires a valid API token for authorization.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/stop_automation
Your tenant: https://{user}.{domain}/api/stop_automation · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/stop_automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&automation=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/stop_automation) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=stop_automation instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
customer_id | number | |
automation | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/stop_automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&automation=value
api_token => (Required) – — customer_id => (Optional) – — automation => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Stop automation
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=stop_automation.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/stop_automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&automation=value'
curl -sS -G 'https://{user}.{domain}/api/stop_automation' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'customer_id=108545' \
--data-urlencode 'automation=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/stop_automation' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","customer_id":"108545","automation":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Automation
Automation API — see your dashboard API Documentation for parameters and Test API.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/automation
Your tenant: https://{user}.{domain}/api/automation · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&key=value&automation_id=value&redirection=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/automation) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=automation instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
customer_id | number | |
key | string | |
automation_id | number | |
redirection | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&key=value&automation_id=value&redirection=value
api_token => (Required) – — customer_id => (Optional) – — key => (Optional) – — automation_id => (Optional) – — redirection => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Automation
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=automation.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/automation?api_token=YOUR_API_TOKEN_FROM_SETTING&customer_id=108545&key=value&automation_id=value'
curl -sS -G 'https://{user}.{domain}/api/automation' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'customer_id=108545' \
--data-urlencode 'key=value' \
--data-urlencode 'automation_id=value' \
--data-urlencode 'redirection=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/automation' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","customer_id":"108545","key":"value","automation_id":"value","redirection":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Customer
This Api Retrieves customer details based on one or more identifiers such as customer ID, phone number, or email address. Requires a valid API token for authorization.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_customer
Your tenant: https://{user}.{domain}/api/get_customer · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_customer) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_customer instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
phone | string | |
email | string | |
id | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&id=value
api_token => (Required) – — phone => (Optional) – — email => (Required) – — id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Customer
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_customer.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_customer?api_token=YOUR_API_TOKEN_FROM_SETTING&phone=0500000000&email=jane%40example.com&id=value'
curl -sS -G 'https://{user}.{domain}/api/get_customer' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'phone=0500000000' \
--data-urlencode '[email protected]' \
--data-urlencode 'id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_customer' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","phone":"0500000000","email":"[email protected]","id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add message
This Api retrives Adds a new message for a specific customer.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_message
Your tenant: https://{user}.{domain}/api/add_message · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_message?cus_id=5258&message=Hey%20I%20am%20here&user_id=14 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_message) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_message instead of the path segment.
| Name | Type | Description |
|---|---|---|
cus_id | number | |
message | string | |
user_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_message?cus_id=5258&message=Hey%20I%20am%20here&user_id=14
cus_id => (Optional) – — message => (Optional) – — user_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add message
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_message.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_message?cus_id=5258&message=Hey%20I%20am%20here&user_id=14'
curl -sS -G 'https://{user}.{domain}/api/add_message' \
--data-urlencode 'cus_id=5258' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'user_id=14'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_message' \
-H 'Content-Type: application/json' \
-d '{"cus_id":"5258","message":"Hey I am here","user_id":"14"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Document (Create Invoice Document)
Creates a new document (such as an invoice,order) by adding customer details, order-level information, and a list of product items. The request requires an authentication token, basic customer info (name, email, phone, address), a JSON object for order details (note, currency, discount, tax), and a JSON array of products (SKU, name, price, discount, quantity, discount type, VAT inclusion, and optional notes).
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&created_by_user_id=value&cust_id=108545&document_lang=value&user_id=14&name=Jane&email=jane%40example.com&mobile=0500000000&phone=0500000000&total=value&final_amount=value&final_amount_main=value&type=value&items=value&payment_method=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&send_by_wp=value&create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
created_by_user_id | number | |
cust_id | number | |
document_lang | string | |
user_id | number | |
name | string | |
email | string | |
mobile | string | |
phone | string | |
total | string | |
final_amount | string | |
final_amount_main | string | |
type | string | |
items | object (JSON) | |
payment_method | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&created_by_user_id=value&cust_id=108545&document_lang=value&user_id=14&name=Jane&email=jane%40example.com&mobile=0500000000&phone=0500000000&total=value&final_amount=value&final_amount_main=value&type=value&items=value&payment_method=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&send_by_wp=value&create_recept_automatic=value
api_token => (Required) – — created_by_user_id => (Optional) – — cust_id => (Optional) – — document_lang => (Optional) – — user_id => (Optional) – — name => (Required) – — email => (Required) – — mobile => (Required) – — phone => (Optional) – — total => (Optional) – — final_amount => (Optional) – — final_amount_main => (Optional) – — type => (Optional) – — items => (Optional) – — payment_method => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Document (Create Invoice Document)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&created_by_user_id=value&cust_id=108545&document_lang=value'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'created_by_user_id=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'user_id=14' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'mobile=0500000000' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'total=value' \
--data-urlencode 'final_amount=value' \
--data-urlencode 'final_amount_main=value' \
--data-urlencode 'type=value' \
--data-urlencode 'items=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","created_by_user_id":"value","cust_id":"108545","document_lang":"value","user_id":"14","name":"Jane","email":"[email protected]","mobile":"0500000000","phone":"0500000000","total":"value","final_amount":"value","final_amount_main":"value","type":"value","items":"value","payment_method":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","send_by_wp":"value","create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Document (Add Order2)
Creates a new document (such as an invoice,order) by adding customer details, order-level information, and a list of product items. The request requires an authentication token, basic customer info (name, email, phone, address), a JSON object for order details (note, currency, discount, tax), and a JSON array of products (SKU, name, price, discount, quantity, discount type, VAT inclusion, and optional notes).
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
last4degits | string | |
payment_method | string | |
document_lang | string | |
invoice_settings_id | number | |
document_type | string | order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt |
order | object (JSON) | |
send_by_wp | string | If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. |
all_items_total | string | |
source | string | |
products | string | |
card_name | string | |
card_no | string | |
month_year | string | must set MM/YY format as we set default value |
cvc | string | |
card_id | number | |
Create_recept_automatic | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&last4degits=value&payment_method=value&document_lang=value&invoice_settings_id=value&document_type=value&order=value&send_by_wp=value&all_items_total=value&source=value&products=value&card_name=value&card_no=value&month_year=value&cvc=value&card_id=value&Create_recept_automatic=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — last4degits => (Optional) – — payment_method => (Optional) – — document_lang => (Optional) – — invoice_settings_id => (Optional) – — document_type => (Required) – order_proposals, purchase_orders, detail_orders, invoice, receipt, receipt_tax_invoice, proforma_invoice, delivery, organization_receipt order => (Optional) – — send_by_wp => (Required) – If set to 1, the generated document will be sent automatically through WhatsApp.Value: 1 = Yes, 0 = No. all_items_total => (Optional) – — source => (Optional) – — products => (Optional) – — card_name => (Optional) – — card_no => (Optional) – — month_year => (Required) – must set MM/YY format as we set default value cvc => (Optional) – — card_id => (Optional) – — Create_recept_automatic => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Document (Add Order2)
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'document_lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'order=value' \
--data-urlencode 'send_by_wp=value' \
--data-urlencode 'all_items_total=value' \
--data-urlencode 'source=value' \
--data-urlencode 'products=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'card_no=value' \
--data-urlencode 'month_year=value' \
--data-urlencode 'cvc=value' \
--data-urlencode 'card_id=value' \
--data-urlencode 'Create_recept_automatic=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","last4degits":"value","payment_method":"value","document_lang":"value","invoice_settings_id":"value","document_type":"value","order":"value","send_by_wp":"value","all_items_total":"value","source":"value","products":"value","card_name":"value","card_no":"value","month_year":"value","cvc":"value","card_id":"value","Create_recept_automatic":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Har Habituach Data
This API inserts “Har Habituach” data for a specific customer. It requires authentication via an api_token and links the data to the customer’s unique cust_id. The Har Habituach report, including fields such as dates, descriptions, and other extracted details from the official Ministry of Finance report.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_har_habituach_data
Your tenant: https://{user}.{domain}/api/add_har_habituach_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_har_habituach_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&har_habituah_data=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_har_habituach_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_har_habituach_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
cust_id | number | |
har_habituah_data | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_har_habituach_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&har_habituah_data=value
api_token => (Required) – — cust_id => (Optional) – — har_habituah_data => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Har Habituach Data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_har_habituach_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_har_habituach_data?api_token=YOUR_API_TOKEN_FROM_SETTING&cust_id=108545&har_habituah_data=value'
curl -sS -G 'https://{user}.{domain}/api/add_har_habituach_data' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'har_habituah_data=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_har_habituach_data' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","cust_id":"108545","har_habituah_data":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Group Green Api Group
This API allows you to create a new WhatsApp group and optionally send a message, set a group image, and update customer data. It requires authentication credentials, the desired group name, and at least one member’s phone number. Additional parameters let you attach an image, send an introductory message, and map values to custom fields for CRM or customer records.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_group_green_api_group
Your tenant: https://{user}.{domain}/api/add_group_green_api_group · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_group_green_api_group?token=YOUR_API_TOKEN&group_name=value&phones=value&instant_phone=value&instant_api_token=value&instant_id=value&image=value&message=Hey%20I%20am%20here&add_data_to_customer=108545&id=value&cf-chat-id=value&cf-group=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_group_green_api_group) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_group_green_api_group instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
group_name | string | |
phones | string | |
instant_phone | string | |
instant_api_token | string | |
instant_id | number | |
image | string | |
message | string | |
add_data_to_customer | string | |
id | string | |
cf-chat-id | string | |
cf-group | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_group_green_api_group?token=YOUR_API_TOKEN&group_name=value&phones=value&instant_phone=value&instant_api_token=value&instant_id=value&image=value&message=Hey%20I%20am%20here&add_data_to_customer=108545&id=value&cf-chat-id=value&cf-group=value
token => (Optional) – — group_name => (Optional) – — phones => (Optional) – — instant_phone => (Optional) – — instant_api_token => (Optional) – — instant_id => (Optional) – — image => (Optional) – — message => (Optional) – — add_data_to_customer => (Optional) – — id => (Optional) – — cf-chat-id => (Optional) – — cf-group => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Group Green Api Group
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_group_green_api_group.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_group_green_api_group?token=YOUR_API_TOKEN&group_name=value&phones=value&instant_phone=value'
curl -sS -G 'https://{user}.{domain}/api/add_group_green_api_group' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'group_name=value' \
--data-urlencode 'phones=value' \
--data-urlencode 'instant_phone=value' \
--data-urlencode 'instant_api_token=value' \
--data-urlencode 'instant_id=value' \
--data-urlencode 'image=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'add_data_to_customer=108545' \
--data-urlencode 'id=value' \
--data-urlencode 'cf-chat-id=value' \
--data-urlencode 'cf-group=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_group_green_api_group' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","group_name":"value","phones":"value","instant_phone":"value","instant_api_token":"value","instant_id":"value","image":"value","message":"Hey I am here","add_data_to_customer":"108545","id":"value","cf-chat-id":"value","cf-group":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add New Member Green Api Group
This API is used to add a specified phone number to a WhatsApp group. It requires authentication using the API token and WhatsApp session credentials, along with the target group ID and the phone number of the member to be added.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_new_member_green_api_group
Your tenant: https://{user}.{domain}/api/add_new_member_green_api_group · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_new_member_green_api_group?token=YOUR_API_TOKEN&groupId=value&phone=0500000000&instant_phone=value&instant_api_token=value&instant_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_new_member_green_api_group) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_new_member_green_api_group instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
groupId | string | |
phone | string | |
instant_phone | string | |
instant_api_token | string | |
instant_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_new_member_green_api_group?token=YOUR_API_TOKEN&groupId=value&phone=0500000000&instant_phone=value&instant_api_token=value&instant_id=value
token => (Optional) – — groupId => (Optional) – — phone => (Optional) – — instant_phone => (Optional) – — instant_api_token => (Optional) – — instant_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add New Member Green Api Group
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_new_member_green_api_group.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_new_member_green_api_group?token=YOUR_API_TOKEN&groupId=value&phone=0500000000&instant_phone=value'
curl -sS -G 'https://{user}.{domain}/api/add_new_member_green_api_group' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'groupId=value' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'instant_phone=value' \
--data-urlencode 'instant_api_token=value' \
--data-urlencode 'instant_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_new_member_green_api_group' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","groupId":"value","phone":"0500000000","instant_phone":"value","instant_api_token":"value","instant_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Update Group Name Green Api
This API updates the name of an existing WhatsApp group via the Green API integration. It requires authentication through both the main user token and the WhatsApp Green API credentials. When called, the specified group will be renamed to the provided group_name.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/update_group_name_green_api
Your tenant: https://{user}.{domain}/api/update_group_name_green_api · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/update_group_name_green_api?token=YOUR_API_TOKEN&groupId=value&group_name=value&instant_phone=value&instant_api_token=value&instant_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/update_group_name_green_api) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=update_group_name_green_api instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
groupId | string | |
group_name | string | |
instant_phone | string | |
instant_api_token | string | |
instant_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/update_group_name_green_api?token=YOUR_API_TOKEN&groupId=value&group_name=value&instant_phone=value&instant_api_token=value&instant_id=value
token => (Optional) – — groupId => (Optional) – — group_name => (Optional) – — instant_phone => (Optional) – — instant_api_token => (Optional) – — instant_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Update Group Name Green Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=update_group_name_green_api.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/update_group_name_green_api?token=YOUR_API_TOKEN&groupId=value&group_name=value&instant_phone=value'
curl -sS -G 'https://{user}.{domain}/api/update_group_name_green_api' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'groupId=value' \
--data-urlencode 'group_name=value' \
--data-urlencode 'instant_phone=value' \
--data-urlencode 'instant_api_token=value' \
--data-urlencode 'instant_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/update_group_name_green_api' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","groupId":"value","group_name":"value","instant_phone":"value","instant_api_token":"value","instant_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Available Doctor Appointment
This API retrieves available appointment slots for a specific doctor within a given date range. You must provide the authentication token, branch ID, appointment type ID, doctor ID, and date range. An optional max parameter controls how many days of availability are returned, with a default of 5 days if not specified.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_available_doctor_appointment
Your tenant: https://{user}.{domain}/api/get_available_doctor_appointment · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_available_doctor_appointment?token=YOUR_API_TOKEN&branch=value&appointment_type=value&max=value&doctor_id=value&from=2026-04-08&to=2026-04-08 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_available_doctor_appointment) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_available_doctor_appointment instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
branch | string | |
appointment_type | string | |
max | string | |
doctor_id | number | |
from | string | must set YYYY-MM-DD format as we set default value |
to | string | must set YYYY-MM-DD format as we set default value |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_available_doctor_appointment?token=YOUR_API_TOKEN&branch=value&appointment_type=value&max=value&doctor_id=value&from=2026-04-08&to=2026-04-08
token => (Optional) – — branch => (Optional) – — appointment_type => (Optional) – — max => (Optional) – — doctor_id => (Optional) – — from => (Required) – must set YYYY-MM-DD format as we set default value to => (Required) – must set YYYY-MM-DD format as we set default value
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Available Doctor Appointment
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_available_doctor_appointment.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_available_doctor_appointment?token=YOUR_API_TOKEN&branch=value&appointment_type=value&max=value'
curl -sS -G 'https://{user}.{domain}/api/get_available_doctor_appointment' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'branch=value' \
--data-urlencode 'appointment_type=value' \
--data-urlencode 'max=value' \
--data-urlencode 'doctor_id=value' \
--data-urlencode 'from=2026-04-08' \
--data-urlencode 'to=2026-04-08'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_available_doctor_appointment' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","branch":"value","appointment_type":"value","max":"value","doctor_id":"value","from":"2026-04-08","to":"2026-04-08"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Approve Doctor Appointmnet
This API approves a specific doctor appointment by providing the authentication token and the appointment ID. Once approved, the appointment status will be update.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/approve_doctor_appointmnet
Your tenant: https://{user}.{domain}/api/approve_doctor_appointmnet · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/approve_doctor_appointmnet?token=YOUR_API_TOKEN&appointment_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/approve_doctor_appointmnet) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=approve_doctor_appointmnet instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
appointment_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/approve_doctor_appointmnet?token=YOUR_API_TOKEN&appointment_id=value
token => (Optional) – — appointment_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Approve Doctor Appointmnet
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=approve_doctor_appointmnet.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/approve_doctor_appointmnet?token=YOUR_API_TOKEN&appointment_id=value'
curl -sS -G 'https://{user}.{domain}/api/approve_doctor_appointmnet' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'appointment_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/approve_doctor_appointmnet' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","appointment_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Expenses
This API is used to add a new expense record by providing your authentication token along with details such as category, amount, document type, and month. You can also include optional information like project ID, payment/document dates, supplier details, attached files, and notes to provide additional context.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_expenses
Your tenant: https://{user}.{domain}/api/add_expenses · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_expenses?token=YOUR_API_TOKEN&category_id=value&amount=value&document_type=value&month=2026-04&project_id=value&file_path=value&thumbnail=value&vat_includes=value¬es=value&payment_date=2026-04-08&document_date=2026-04-08&check_number=value&supplier_company_id=value&supplier_name=value&supplier_phone=value&supplier_email=value&invoice_number=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_expenses) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_expenses instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
category_id | number | |
amount | string | |
document_type | string | |
month | string | must set YYYY-MM format as we set default value |
project_id | number | |
file_path | string | |
thumbnail | string | |
vat_includes | string | |
notes | string | |
payment_date | string | must set YYYY-MM-DD format as we set default value |
document_date | string | must set YYYY-MM-DD format as we set default value |
check_number | string | |
supplier_company_id | number | |
supplier_name | string | |
supplier_phone | string | |
supplier_email | string | |
invoice_number | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_expenses?token=YOUR_API_TOKEN&category_id=value&amount=value&document_type=value&month=2026-04&project_id=value&file_path=value&thumbnail=value&vat_includes=value¬es=value&payment_date=2026-04-08&document_date=2026-04-08&check_number=value&supplier_company_id=value&supplier_name=value&supplier_phone=value&supplier_email=value&invoice_number=value
token => (Optional) – — category_id => (Optional) – — amount => (Optional) – — document_type => (Optional) – — month => (Required) – must set YYYY-MM format as we set default value project_id => (Optional) – — file_path => (Optional) – — thumbnail => (Optional) – — vat_includes => (Optional) – — notes => (Optional) – — payment_date => (Required) – must set YYYY-MM-DD format as we set default value document_date => (Required) – must set YYYY-MM-DD format as we set default value check_number => (Optional) – — supplier_company_id => (Optional) – — supplier_name => (Optional) – — supplier_phone => (Optional) – — supplier_email => (Optional) – — invoice_number => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Expenses
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_expenses.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_expenses?token=YOUR_API_TOKEN&category_id=value&amount=value&document_type=value'
curl -sS -G 'https://{user}.{domain}/api/add_expenses' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'category_id=value' \
--data-urlencode 'amount=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'month=2026-04' \
--data-urlencode 'project_id=value' \
--data-urlencode 'file_path=value' \
--data-urlencode 'thumbnail=value' \
--data-urlencode 'vat_includes=value' \
--data-urlencode 'notes=value' \
--data-urlencode 'payment_date=2026-04-08' \
--data-urlencode 'document_date=2026-04-08' \
--data-urlencode 'check_number=value' \
--data-urlencode 'supplier_company_id=value' \
--data-urlencode 'supplier_name=value' \
--data-urlencode 'supplier_phone=value' \
--data-urlencode 'supplier_email=value' \
--data-urlencode 'invoice_number=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_expenses' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","category_id":"value","amount":"value","document_type":"value","month":"2026-04","project_id":"value","file_path":"value","thumbnail":"value","vat_includes":"value","notes":"value","payment_date":"2026-04-08","document_date":"2026-04-08","check_number":"value","supplier_company_id":"value","supplier_name":"value","supplier_phone":"value","supplier_email":"value","invoice_number":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Create Document
Creates a new document (such as an invoice,order) by adding customer details, order-level information, and a list of product items. The request requires an authentication token, basic customer info (name, email, phone, address), a JSON object for order details (note, currency, discount, tax), and a JSON array of products (SKU, name, price, discount, quantity, discount type, VAT inclusion, and optional notes).
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_order2
Your tenant: https://{user}.{domain}/api/add_order2 · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&order=value&last4degits=value&document_type=value&reciept_tax_invoice=value&invoice_create=value&payment_method=value&source=value&lang=value&invoice_settings_id=value&draft=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_order2) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_order2 instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
phone | string | |
address | string | |
order | object (JSON) | |
last4degits | string | |
document_type | string | |
reciept_tax_invoice | string | |
invoice_create | string | |
payment_method | string | |
source | string | |
lang | string | |
invoice_settings_id | number | |
draft | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000&address=value&order=value&last4degits=value&document_type=value&reciept_tax_invoice=value&invoice_create=value&payment_method=value&source=value&lang=value&invoice_settings_id=value&draft=value
api_token => (Required) – — name => (Required) – — email => (Required) – — phone => (Optional) – — address => (Optional) – — order => (Optional) – — last4degits => (Optional) – — document_type => (Optional) – — reciept_tax_invoice => (Optional) – — invoice_create => (Optional) – — payment_method => (Optional) – — source => (Optional) – — lang => (Optional) – — invoice_settings_id => (Optional) – — draft => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Create Document
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_order2.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_order2?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_order2' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'address=value' \
--data-urlencode 'order=value' \
--data-urlencode 'last4degits=value' \
--data-urlencode 'document_type=value' \
--data-urlencode 'reciept_tax_invoice=value' \
--data-urlencode 'invoice_create=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'source=value' \
--data-urlencode 'lang=value' \
--data-urlencode 'invoice_settings_id=value' \
--data-urlencode 'draft=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_order2' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","phone":"0500000000","address":"value","order":"value","last4degits":"value","document_type":"value","reciept_tax_invoice":"value","invoice_create":"value","payment_method":"value","source":"value","lang":"value","invoice_settings_id":"value","draft":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Customer
This API is used for add lead. api_token (User api_token), name (Customer name), email (Customer email), mobile (Customer mobile) is the required parameter The rest parameter is optional After hit the api the record is inserted in contactus table and we will get all details of customer in response.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_lead
Your tenant: https://{user}.{domain}/api/add_lead · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_lead?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&mobile=0500000000&password=value&address=value&message=Hey%20I%20am%20here&source=value&subject=value¬es=value&folders=value&redirection=value&by_automation=value&by_automation_add_order=value&related_id=value&internal_status_id=value&company_id=value&checkUnique=value&city=value&add_file=value&add_file_from_path=value&add_file_folder=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_lead) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_lead instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
name | string | |
email | string | |
mobile | string | |
password | string | |
address | string | |
message | string | |
source | string | |
subject | string | |
notes | string | |
folders | string | |
redirection | string | |
by_automation | string | |
by_automation_add_order | string | |
related_id | number | |
internal_status_id | number | |
company_id | number | |
checkUnique | string | |
city | string | |
add_file | string | Uploads a local file (image, PDF, document, etc.) and attaches it to the lead. |
add_file_from_path | string | Publicly accessible file URL. The API downloads the file and attaches it to the lead. |
add_file_folder | string | Folder where the downloaded file will be stored. Can be folder ID or folder name. System file folder name must in that shortcode(default, sign, whatsapp_files, forms, email_files). For any other folder, use folder_id. Defaults to default. |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_lead?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&mobile=0500000000&password=value&address=value&message=Hey%20I%20am%20here&source=value&subject=value¬es=value&folders=value&redirection=value&by_automation=value&by_automation_add_order=value&related_id=value&internal_status_id=value&company_id=value&checkUnique=value&city=value&add_file=value&add_file_from_path=value&add_file_folder=value
api_token => (Required) – — name => (Required) – — email => (Required) – — mobile => (Required) – — password => (Optional) – — address => (Optional) – — message => (Optional) – — source => (Optional) – — subject => (Optional) – — notes => (Optional) – — folders => (Optional) – — redirection => (Optional) – — by_automation => (Optional) – — by_automation_add_order => (Optional) – — related_id => (Optional) – — internal_status_id => (Optional) – — company_id => (Optional) – — checkUnique => (Optional) – — city => (Optional) – — add_file => (Required) – Uploads a local file (image, PDF, document, etc.) and attaches it to the lead. add_file_from_path => (Required) – Publicly accessible file URL. The API downloads the file and attaches it to the lead. add_file_folder => (Required) – Folder where the downloaded file will be stored. Can be folder ID or folder name. System file folder name must in that shortcode(default, sign, whatsapp_files, forms, email_files). For any other folder, use folder_id. Defaults to default.
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Customer
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_lead.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_lead?api_token=YOUR_API_TOKEN_FROM_SETTING&name=Jane&email=jane%40example.com&mobile=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_lead' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'name=Jane' \
--data-urlencode '[email protected]' \
--data-urlencode 'mobile=0500000000' \
--data-urlencode 'password=value' \
--data-urlencode 'address=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'source=value' \
--data-urlencode 'subject=value' \
--data-urlencode 'notes=value' \
--data-urlencode 'folders=value' \
--data-urlencode 'redirection=value' \
--data-urlencode 'by_automation=value' \
--data-urlencode 'by_automation_add_order=value' \
--data-urlencode 'related_id=value' \
--data-urlencode 'internal_status_id=value' \
--data-urlencode 'company_id=value' \
--data-urlencode 'checkUnique=value' \
--data-urlencode 'city=value' \
--data-urlencode 'add_file=value' \
--data-urlencode 'add_file_from_path=value' \
--data-urlencode 'add_file_folder=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_lead' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","name":"Jane","email":"[email protected]","mobile":"0500000000","password":"value","address":"value","message":"Hey I am here","source":"value","subject":"value","notes":"value","folders":"value","redirection":"value","by_automation":"value","by_automation_add_order":"value","related_id":"value","internal_status_id":"value","company_id":"value","checkUnique":"value","city":"value","add_file":"value","add_file_from_path":"value","add_file_folder":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Update Order
The update_order API allows you to modify specific fields of an order by providing its unique order_id. This operation requires an api_token to authenticate the request and ensure the user has permission to perform updates. Along with required parameters, you can pass optional or custom fields to change the order’s status or update other order-related metadata.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/update_order
Your tenant: https://{user}.{domain}/api/update_order · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/update_order?api_token=YOUR_API_TOKEN_FROM_SETTING&order_id=value&order-cf-status=value&order-cf-redirection=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/update_order) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=update_order instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
order_id | number | |
order-cf-status | string | |
order-cf-redirection | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/update_order?api_token=YOUR_API_TOKEN_FROM_SETTING&order_id=value&order-cf-status=value&order-cf-redirection=value
api_token => (Required) – — order_id => (Optional) – — order-cf-status => (Optional) – — order-cf-redirection => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Update Order
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=update_order.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/update_order?api_token=YOUR_API_TOKEN_FROM_SETTING&order_id=value&order-cf-status=value&order-cf-redirection=value'
curl -sS -G 'https://{user}.{domain}/api/update_order' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'order_id=value' \
--data-urlencode 'order-cf-status=value' \
--data-urlencode 'order-cf-redirection=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/update_order' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","order_id":"value","order-cf-status":"value","order-cf-redirection":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Update Customer Fields
Update Customer Filds Retrives a Updates specified record fields with new values based on the provided record ID and authentication token.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/update_customer_fields
Your tenant: https://{user}.{domain}/api/update_customer_fields · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/update_customer_fields?api_token=YOUR_API_TOKEN_FROM_SETTING&fields=value&values=value&id=value&folders=value&internal_status=value&internal_sub_status=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/update_customer_fields) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=update_customer_fields instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
fields | string | |
values | string | |
id | string | |
folders | string | |
internal_status | string | |
internal_sub_status | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/update_customer_fields?api_token=YOUR_API_TOKEN_FROM_SETTING&fields=value&values=value&id=value&folders=value&internal_status=value&internal_sub_status=value
api_token => (Required) – — fields => (Optional) – — values => (Optional) – — id => (Optional) – — folders => (Optional) – — internal_status => (Optional) – — internal_sub_status => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Update Customer Fields
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=update_customer_fields.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/update_customer_fields?api_token=YOUR_API_TOKEN_FROM_SETTING&fields=value&values=value&id=value'
curl -sS -G 'https://{user}.{domain}/api/update_customer_fields' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'fields=value' \
--data-urlencode 'values=value' \
--data-urlencode 'id=value' \
--data-urlencode 'folders=value' \
--data-urlencode 'internal_status=value' \
--data-urlencode 'internal_sub_status=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/update_customer_fields' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","fields":"value","values":"value","id":"value","folders":"value","internal_status":"value","internal_sub_status":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Charge Appointment
This API charges a payment for a specific appointment using the provided credit card details. It verifies the card information, processes the transaction, and links the payment to the given appointment ID. The request must include valid authentication via the customer’s token to ensure secure and authorized payment processing.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/charge_appointment
Your tenant: https://{user}.{domain}/api/charge_appointment · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/charge_appointment?token=YOUR_API_TOKEN&card_no=value&card_month=value&card_year=value&card_cvc=value&card_name=value&appointment_id=value&payment_detail_id=value&payment_method=value&invoice_setting_id=value&amount=value&doc_type=value&card_pin=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/charge_appointment) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=charge_appointment instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
card_no | string | |
card_month | string | |
card_year | string | |
card_cvc | string | |
card_name | string | |
appointment_id | number | |
payment_detail_id | number | |
payment_method | string | |
invoice_setting_id | number | |
amount | string | |
doc_type | string | |
card_pin | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/charge_appointment?token=YOUR_API_TOKEN&card_no=value&card_month=value&card_year=value&card_cvc=value&card_name=value&appointment_id=value&payment_detail_id=value&payment_method=value&invoice_setting_id=value&amount=value&doc_type=value&card_pin=value
token => (Optional) – — card_no => (Optional) – — card_month => (Optional) – — card_year => (Optional) – — card_cvc => (Optional) – — card_name => (Optional) – — appointment_id => (Optional) – — payment_detail_id => (Optional) – — payment_method => (Optional) – — invoice_setting_id => (Optional) – — amount => (Optional) – — doc_type => (Optional) – — card_pin => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Charge Appointment
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=charge_appointment.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/charge_appointment?token=YOUR_API_TOKEN&card_no=value&card_month=value&card_year=value'
curl -sS -G 'https://{user}.{domain}/api/charge_appointment' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'card_no=value' \
--data-urlencode 'card_month=value' \
--data-urlencode 'card_year=value' \
--data-urlencode 'card_cvc=value' \
--data-urlencode 'card_name=value' \
--data-urlencode 'appointment_id=value' \
--data-urlencode 'payment_detail_id=value' \
--data-urlencode 'payment_method=value' \
--data-urlencode 'invoice_setting_id=value' \
--data-urlencode 'amount=value' \
--data-urlencode 'doc_type=value' \
--data-urlencode 'card_pin=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/charge_appointment' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","card_no":"value","card_month":"value","card_year":"value","card_cvc":"value","card_name":"value","appointment_id":"value","payment_detail_id":"value","payment_method":"value","invoice_setting_id":"value","amount":"value","doc_type":"value","card_pin":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Room Details By Filter
The Get Rooms Details By Filter API retrieves a list of rooms that match specific search filters. By providing a valid authentication token and required booking details such as the number of guests, check-in, and check-out dates, the API returns available rooms that meet the given criteria. Optional filters such as city, area, bedrooms, price range, maximum results, and pagination can further refine the search. This API is useful for implementing advanced room search functionality with flexible filtering options.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_room_details_by_filter
Your tenant: https://{user}.{domain}/api/get_room_details_by_filter · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_room_details_by_filter?token=YOUR_API_TOKEN&guests=value&city=value&area=value&bedrooms=value&from_date=2026-04-08&to_date=2026-04-08&from_price=value&to_price=value&max=value&page_id=value&wifi=value&swimming_pool=value&location_for_map=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_room_details_by_filter) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_room_details_by_filter instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
guests | string | |
city | string | |
area | string | |
bedrooms | string | |
from_date | string | must set YYYY-MM-DD format as we set default value |
to_date | string | must set YYYY-MM-DD format as we set default value |
from_price | string | |
to_price | string | |
max | string | |
page_id | number | |
wifi | string | 1 for with wifi, 0 for wifi |
swimming_pool | string | 1 for with swimming_pool, 0 for swimming_pool |
location_for_map | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_room_details_by_filter?token=YOUR_API_TOKEN&guests=value&city=value&area=value&bedrooms=value&from_date=2026-04-08&to_date=2026-04-08&from_price=value&to_price=value&max=value&page_id=value&wifi=value&swimming_pool=value&location_for_map=value
token => (Optional) – — guests => (Optional) – — city => (Optional) – — area => (Optional) – — bedrooms => (Optional) – — from_date => (Required) – must set YYYY-MM-DD format as we set default value to_date => (Required) – must set YYYY-MM-DD format as we set default value from_price => (Optional) – — to_price => (Optional) – — max => (Optional) – — page_id => (Optional) – — wifi => (Required) – 1 for with wifi, 0 for wifi swimming_pool => (Required) – 1 for with swimming_pool, 0 for swimming_pool location_for_map => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Room Details By Filter
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_room_details_by_filter.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_room_details_by_filter?token=YOUR_API_TOKEN&guests=value&city=value&area=value'
curl -sS -G 'https://{user}.{domain}/api/get_room_details_by_filter' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'guests=value' \
--data-urlencode 'city=value' \
--data-urlencode 'area=value' \
--data-urlencode 'bedrooms=value' \
--data-urlencode 'from_date=2026-04-08' \
--data-urlencode 'to_date=2026-04-08' \
--data-urlencode 'from_price=value' \
--data-urlencode 'to_price=value' \
--data-urlencode 'max=value' \
--data-urlencode 'page_id=value' \
--data-urlencode 'wifi=value' \
--data-urlencode 'swimming_pool=value' \
--data-urlencode 'location_for_map=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_room_details_by_filter' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","guests":"value","city":"value","area":"value","bedrooms":"value","from_date":"2026-04-08","to_date":"2026-04-08","from_price":"value","to_price":"value","max":"value","page_id":"value","wifi":"value","swimming_pool":"value","location_for_map":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Room Bokking
The Add Room Booking API creates a new booking for a specified room. It requires the customer’s authentication token, room ID, booking dates, and price, along with either a customer ID or phone number to identify the customer. Optional parameters allow adding notes, payment status, discount, room display name, and description. This API is used to confirm reservations, record booking details, and manage room availability in the system.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_room_bokking
Your tenant: https://{user}.{domain}/api/add_room_bokking · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_room_bokking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&phone=0500000000&start_date=2026-04-08&end_date=2026-04-08¬es=value&paid_status=value&price=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_room_bokking) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_room_bokking instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
room_id | number | |
cust_id | number | |
phone | string | |
start_date | string | must set YYYY-MM-DD format as we set default value |
end_date | string | must set YYYY-MM-DD format as we set default value |
notes | string | |
paid_status | string | Indicates the payment status of the booking. Use 1 for paid and 0 for unpaid |
price | string | |
discount | string | |
room_display_name | string | |
room_row_id | number | |
block_this_time_room | string | |
description | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_room_bokking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&phone=0500000000&start_date=2026-04-08&end_date=2026-04-08¬es=value&paid_status=value&price=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value
token => (Optional) – — room_id => (Optional) – — cust_id => (Optional) – — phone => (Optional) – — start_date => (Required) – must set YYYY-MM-DD format as we set default value end_date => (Required) – must set YYYY-MM-DD format as we set default value notes => (Optional) – — paid_status => (Required) – Indicates the payment status of the booking. Use 1 for paid and 0 for unpaid price => (Optional) – — discount => (Optional) – — room_display_name => (Optional) – — room_row_id => (Optional) – — block_this_time_room => (Optional) – — description => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Room Bokking
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_room_bokking.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_room_bokking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&phone=0500000000'
curl -sS -G 'https://{user}.{domain}/api/add_room_bokking' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'room_id=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'start_date=2026-04-08' \
--data-urlencode 'end_date=2026-04-08' \
--data-urlencode 'notes=value' \
--data-urlencode 'paid_status=value' \
--data-urlencode 'price=value' \
--data-urlencode 'discount=value' \
--data-urlencode 'room_display_name=value' \
--data-urlencode 'room_row_id=value' \
--data-urlencode 'block_this_time_room=value' \
--data-urlencode 'description=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_room_bokking' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","room_id":"value","cust_id":"108545","phone":"0500000000","start_date":"2026-04-08","end_date":"2026-04-08","notes":"value","paid_status":"value","price":"value","discount":"value","room_display_name":"value","room_row_id":"value","block_this_time_room":"value","description":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Recording
The Add Recording API is used to store call recording details in the system for a specific client or phone number. By providing the user’s authentication token, client ID, call type (incoming or outgoing), and optionally details such as phone number, notes, message, duration, answer status, and recording URL, this API logs and associates the call information with the relevant user record. It helps maintain a detailed call history, including recordings and related metadata, for tracking and reference purposes
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_recording
Your tenant: https://{user}.{domain}/api/add_recording · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_recording?token=YOUR_API_TOKEN&cust_id=108545&mobile=0500000000&type=value¬e=value&message=Hey%20I%20am%20here&duration=value&answerd=value&recording_url=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_recording) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_recording instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
cust_id | number | |
mobile | string | |
type | string | Defines call direction. Allowed: in_call (incoming), out_call (outgoing). |
note | string | |
message | string | |
duration | string | |
answerd | string | Whether the call was answered. 1 = answered, 0 = not answered. (default 1) |
recording_url | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_recording?token=YOUR_API_TOKEN&cust_id=108545&mobile=0500000000&type=value¬e=value&message=Hey%20I%20am%20here&duration=value&answerd=value&recording_url=value
token => (Optional) – — cust_id => (Optional) – — mobile => (Required) – — type => (Required) – Defines call direction. Allowed: in_call (incoming), out_call (outgoing). note => (Optional) – — message => (Optional) – — duration => (Optional) – — answerd => (Required) – Whether the call was answered. 1 = answered, 0 = not answered. (default 1) recording_url => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Recording
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_recording.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_recording?token=YOUR_API_TOKEN&cust_id=108545&mobile=0500000000&type=value'
curl -sS -G 'https://{user}.{domain}/api/add_recording' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'mobile=0500000000' \
--data-urlencode 'type=value' \
--data-urlencode 'note=value' \
--data-urlencode 'message=Hey I am here' \
--data-urlencode 'duration=value' \
--data-urlencode 'answerd=value' \
--data-urlencode 'recording_url=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_recording' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","cust_id":"108545","mobile":"0500000000","type":"value","note":"value","message":"Hey I am here","duration":"value","answerd":"value","recording_url":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Booking Room List By Room Id
The Get Availability for Rooms API checks and returns the available booking dates or time slots for a specific room. By providing a valid authentication token and the room’s ID, the API retrieves the room’s current availability status, helping customers determine when the room can be booked.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_booking_room_list_by_room_id
Your tenant: https://{user}.{domain}/api/get_booking_room_list_by_room_id · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_booking_room_list_by_room_id?token=YOUR_API_TOKEN&room_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_booking_room_list_by_room_id) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_booking_room_list_by_room_id instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
room_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_booking_room_list_by_room_id?token=YOUR_API_TOKEN&room_id=value
token => (Optional) – — room_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Booking Room List By Room Id
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_booking_room_list_by_room_id.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_booking_room_list_by_room_id?token=YOUR_API_TOKEN&room_id=value'
curl -sS -G 'https://{user}.{domain}/api/get_booking_room_list_by_room_id' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'room_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_booking_room_list_by_room_id' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","room_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get All Room Data
The Get Rooms API Returns a list of all rooms belonging to the authenticated user’s owner_id, including full room details, images, amenities, pricing, coordinates, and the list of bookings for each room.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_room_data
Your tenant: https://{user}.{domain}/api/get_room_data · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_room_data?token=YOUR_API_TOKEN — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_room_data) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_room_data instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_room_data?token=YOUR_API_TOKEN
token => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get All Room Data
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_room_data.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_room_data?token=YOUR_API_TOKEN'
curl -sS -G 'https://{user}.{domain}/api/get_room_data' \
--data-urlencode 'token=YOUR_API_TOKEN'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_room_data' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Delete Calender Metting
Cancels a scheduled calendar appointment for a customer by specifying the start time, date, and phone number, along with the customer’s authentication token.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/delete_calender_metting
Your tenant: https://{user}.{domain}/api/delete_calender_metting · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/delete_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&client_id=value&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/delete_calender_metting) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=delete_calender_metting instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
appo_from | string | must set HH:MM formate as we set default value |
date | string | must set DD.MM.YYYY format as we set default value |
client_id | number | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/delete_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&client_id=value&phone=0500000000
api_token => (Required) – — appo_from => (Required) – must set HH:MM formate as we set default value date => (Required) – must set DD.MM.YYYY format as we set default value client_id => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Delete Calender Metting
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=delete_calender_metting.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/delete_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&appo_from=value&date=value&client_id=value'
curl -sS -G 'https://{user}.{domain}/api/delete_calender_metting' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'appo_from=value' \
--data-urlencode 'date=value' \
--data-urlencode 'client_id=value' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/delete_calender_metting' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","appo_from":"value","date":"value","client_id":"value","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Add Calender Metting
The Add Calendar API is used to create a new appointment or calendar event for a customer. It requires the customer’s authentication token along with event details such as title, color tag, time range, location, notes, and date. The API also supports linking the event to a specific user either by providing a client_id or a phone number (at least one is required). This enables efficient scheduling and management of customer appointments with clear identification, color coding, and detailed information.
GET / POST · Product list may show POST only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/add_calender_metting
Your tenant: https://{user}.{domain}/api/add_calender_metting · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/add_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&title=value&appoinment_color=value&appo_from=value&appo_to=value&appoiment_address=value¬e=value&date=value&phone=0500000000&client_name=value&client_id=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/add_calender_metting) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=add_calender_metting instead of the path segment.
| Name | Type | Description |
|---|---|---|
api_token | string | |
title | string | |
appoinment_color | string | |
appo_from | string | must set HH:MM format as we set default value |
appo_to | string | must set HH:MM format as we set default value |
appoiment_address | string | |
note | string | |
date | string | must set DD.MM.YYYY format as we set default value |
phone | string | |
client_name | string | |
client_id | number |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/add_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&title=value&appoinment_color=value&appo_from=value&appo_to=value&appoiment_address=value¬e=value&date=value&phone=0500000000&client_name=value&client_id=value
api_token => (Required) – — title => (Optional) – — appoinment_color => (Optional) – — appo_from => (Required) – must set HH:MM format as we set default value appo_to => (Required) – must set HH:MM format as we set default value appoiment_address => (Optional) – — note => (Optional) – — date => (Required) – must set DD.MM.YYYY format as we set default value phone => (Optional) – — client_name => (Optional) – — client_id => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Add Calender Metting
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=add_calender_metting.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/add_calender_metting?api_token=YOUR_API_TOKEN_FROM_SETTING&title=value&appoinment_color=value&appo_from=value'
curl -sS -G 'https://{user}.{domain}/api/add_calender_metting' \
--data-urlencode 'api_token=YOUR_API_TOKEN_FROM_SETTING' \
--data-urlencode 'title=value' \
--data-urlencode 'appoinment_color=value' \
--data-urlencode 'appo_from=value' \
--data-urlencode 'appo_to=value' \
--data-urlencode 'appoiment_address=value' \
--data-urlencode 'note=value' \
--data-urlencode 'date=value' \
--data-urlencode 'phone=0500000000' \
--data-urlencode 'client_name=value' \
--data-urlencode 'client_id=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/add_calender_metting' \
-H 'Content-Type: application/json' \
-d '{"api_token":"YOUR_API_TOKEN_FROM_SETTING","title":"value","appoinment_color":"value","appo_from":"value","appo_to":"value","appoiment_address":"value","note":"value","date":"value","phone":"0500000000","client_name":"value","client_id":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Available Slot For Calender Metting
The Get Available Slot Calendar API returns a list of available meeting or booking time slots within a specified date range. By providing the date range, preferred time of day, and slot duration, the API generates up to the maximum number of available slots allowed. This is useful for scheduling appointments or reservations based on availability.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_available_slot_for_calender_metting
Your tenant: https://{user}.{domain}/api/get_available_slot_for_calender_metting · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_available_slot_for_calender_metting?token=YOUR_API_TOKEN&team_member=value&max=value&from=2026-04-08&to=2026-04-08&preffer=value&duration=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_available_slot_for_calender_metting) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_available_slot_for_calender_metting instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
team_member | string | |
max | string | |
from | string | must set YYYY-MM-DD format as we set default value |
to | string | must set YYYY-MM-DD format as we set default value |
preffer | string | |
duration | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_available_slot_for_calender_metting?token=YOUR_API_TOKEN&team_member=value&max=value&from=2026-04-08&to=2026-04-08&preffer=value&duration=value
token => (Optional) – — team_member => (Optional) – — max => (Optional) – — from => (Required) – must set YYYY-MM-DD format as we set default value to => (Required) – must set YYYY-MM-DD format as we set default value preffer => (Optional) – — duration => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Available Slot For Calender Metting
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_available_slot_for_calender_metting.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_available_slot_for_calender_metting?token=YOUR_API_TOKEN&team_member=value&max=value&from=2026-04-08'
curl -sS -G 'https://{user}.{domain}/api/get_available_slot_for_calender_metting' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'team_member=value' \
--data-urlencode 'max=value' \
--data-urlencode 'from=2026-04-08' \
--data-urlencode 'to=2026-04-08' \
--data-urlencode 'preffer=value' \
--data-urlencode 'duration=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_available_slot_for_calender_metting' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","team_member":"value","max":"value","from":"2026-04-08","to":"2026-04-08","preffer":"value","duration":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Get Available Date For Room Booking
The Get Available Date of Room API retrieves all available booking dates for a specific month. By providing the authentication token and a target month in YYYY-MM format, the API returns the dates when rooms are available.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/get_available_date_for_room_booking
Your tenant: https://{user}.{domain}/api/get_available_date_for_room_booking · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/get_available_date_for_room_booking?token=YOUR_API_TOKEN&date=2026-04 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/get_available_date_for_room_booking) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=get_available_date_for_room_booking instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
date | string | must set YYYY-MM format as we set default value |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/get_available_date_for_room_booking?token=YOUR_API_TOKEN&date=2026-04
token => (Optional) – — date => (Required) – must set YYYY-MM format as we set default value
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Get Available Date For Room Booking
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=get_available_date_for_room_booking.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/get_available_date_for_room_booking?token=YOUR_API_TOKEN&date=2026-04'
curl -sS -G 'https://{user}.{domain}/api/get_available_date_for_room_booking' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'date=2026-04'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/get_available_date_for_room_booking' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","date":"2026-04"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Room Booking Api
This API creates a new booking for a specified room and customer, storing details such as booking dates, price, payment status, and optional notes. It can also block the room for the booked period if required.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/room_booking
Your tenant: https://{user}.{domain}/api/room_booking · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/room_booking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&start_date=2026-04-08&end_date=2026-04-08¬es=value&paid_status=value&price=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/room_booking) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=room_booking instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
room_id | number | |
cust_id | number | |
start_date | string | must set YYYY-MM-DD format as we set default value |
end_date | string | must set YYYY-MM-DD format as we set default value |
notes | string | |
paid_status | string | Payment status: 0 = unpaid, 1 = paid. |
price | string | |
discount | string | |
room_display_name | string | |
room_row_id | number | |
block_this_time_room | string | |
description | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/room_booking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&start_date=2026-04-08&end_date=2026-04-08¬es=value&paid_status=value&price=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value
token => (Optional) – — room_id => (Optional) – — cust_id => (Optional) – — start_date => (Required) – must set YYYY-MM-DD format as we set default value end_date => (Required) – must set YYYY-MM-DD format as we set default value notes => (Optional) – — paid_status => (Required) – Payment status: 0 = unpaid, 1 = paid. price => (Optional) – — discount => (Optional) – — room_display_name => (Optional) – — room_row_id => (Optional) – — block_this_time_room => (Optional) – — description => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Room Booking Api
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=room_booking.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/room_booking?token=YOUR_API_TOKEN&room_id=value&cust_id=108545&start_date=2026-04-08'
curl -sS -G 'https://{user}.{domain}/api/room_booking' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'room_id=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'start_date=2026-04-08' \
--data-urlencode 'end_date=2026-04-08' \
--data-urlencode 'notes=value' \
--data-urlencode 'paid_status=value' \
--data-urlencode 'price=value' \
--data-urlencode 'discount=value' \
--data-urlencode 'room_display_name=value' \
--data-urlencode 'room_row_id=value' \
--data-urlencode 'block_this_time_room=value' \
--data-urlencode 'description=value'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/room_booking' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","room_id":"value","cust_id":"108545","start_date":"2026-04-08","end_date":"2026-04-08","notes":"value","paid_status":"value","price":"value","discount":"value","room_display_name":"value","room_row_id":"value","block_this_time_room":"value","description":"value"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.
Book Room
book_room — creates or confirms a room booking; see dashboard API Documentation for full parameter list.
GET / POST · Product list may show GET only; the same fields work as query (GET) or body (POST).
Endpoint
https://biz1.co.il/api/book_room
Your tenant: https://{user}.{domain}/api/book_room · alt: https://{user}.{domain}/api.php
Example GET URL: https://biz1.co.il/api/book_room?token=YOUR_API_TOKEN&room_id=value&start_date=2026-04-08&end_date=2026-04-08¬es=value&price=value&cust_id=108545&paid_status=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value&phone=0500000000 — operation is in the path; add every other field from the table to the query string (no api=).
Parameters
The operation name is already in the URL path (…/book_room) — do not add a separate api= field for this endpoint. Use the same field names as Test API as GET query parameters and/or POST JSON or form. Legacy: you can call api.php with api=book_room instead of the path segment.
| Name | Type | Description |
|---|---|---|
token | string | |
room_id | number | |
start_date | string | must set YYYY-MM-DD format as we set default value |
end_date | string | must set YYYY-MM-DD format as we set default value |
notes | string | |
price | string | |
cust_id | number | |
paid_status | string | |
discount | string | |
room_display_name | string | |
room_row_id | number | |
block_this_time_room | string | |
description | string | |
phone | string |
Status codes
Typically 200 OK with JSON; validation or auth errors return 4xx. Exact messages depend on your Biz1 environment.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
Other description
https://biz1.co.il/api/book_room?token=YOUR_API_TOKEN&room_id=value&start_date=2026-04-08&end_date=2026-04-08¬es=value&price=value&cust_id=108545&paid_status=value&discount=value&room_display_name=value&room_row_id=value&block_this_time_room=value&description=value&phone=0500000000
token => (Optional) – — room_id => (Optional) – — start_date => (Required) – must set YYYY-MM-DD format as we set default value end_date => (Required) – must set YYYY-MM-DD format as we set default value notes => (Optional) – — price => (Optional) – — cust_id => (Optional) – — paid_status => (Optional) – — discount => (Optional) – — room_display_name => (Optional) – — room_row_id => (Optional) – — block_this_time_room => (Optional) – — description => (Optional) – — phone => (Optional) – —
Sample response
{
"success": true,
"data": {}
}
Response shape varies by operation.
Try it — Set your tenant host and token in the tester below, then send GET or POST through this site’s proxy.
Code samples (GET & POST)
Examples use the parameter names and examples from the table above — GET as query string, POST with the same keys as JSON or form.
# Operation: Book Room
# Host: replace {user}.{domain} with your tenant.
# Path includes the operation — no separate api= field. Legacy: POST/GET the same fields to https://{user}.{domain}/api.php with api=book_room.
# --- GET (query string) ---
# One-line sample (add every parameter from the table):
curl -sS 'https://{user}.{domain}/api/book_room?token=YOUR_API_TOKEN&room_id=value&start_date=2026-04-08&end_date=2026-04-08'
curl -sS -G 'https://{user}.{domain}/api/book_room' \
--data-urlencode 'token=YOUR_API_TOKEN' \
--data-urlencode 'room_id=value' \
--data-urlencode 'start_date=2026-04-08' \
--data-urlencode 'end_date=2026-04-08' \
--data-urlencode 'notes=value' \
--data-urlencode 'price=value' \
--data-urlencode 'cust_id=108545' \
--data-urlencode 'paid_status=value' \
--data-urlencode 'discount=value' \
--data-urlencode 'room_display_name=value' \
--data-urlencode 'room_row_id=value' \
--data-urlencode 'block_this_time_room=value' \
--data-urlencode 'description=value' \
--data-urlencode 'phone=0500000000'
# --- POST (JSON body — same field names) ---
curl -sS -X POST 'https://{user}.{domain}/api/book_room' \
-H 'Content-Type: application/json' \
-d '{"token":"YOUR_API_TOKEN","room_id":"value","start_date":"2026-04-08","end_date":"2026-04-08","notes":"value","price":"value","cust_id":"108545","paid_status":"value","discount":"value","room_display_name":"value","room_row_id":"value","block_this_time_room":"value","description":"value","phone":"0500000000"}'Try it — send from this site
Your token is sent only to this site’s proxy to forward the request to Biz1 — it is not stored.