POST

PaymentForms.List

List payment form templates for the account (Settings → Payment forms step 3/3, table payment_forms). Page size capped at 25.

Permissions

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

Action

Returns PaymentForms rows as JSON.
Supports the documented filters and paging fields.
List responses are capped at 25 rows per call.

Push Service

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

Automation

No automation is run for this function.

Special Instructions

On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
Org templates only (payment_forms). Customer-assigned rows use Customer.PaymentForms.List.
Each row includes template_payment_link with {hased_id} placeholder until assigned to a customer.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`search` post	string	`membership`	Search form_name. Aliases: search_text, filter_data, form_name.
`iteam_type` post	string	`product`	Filter by item type: product, order, appointment_type, appointment_group, subscription. Alias: item_type.
`limit` post	int	`25`	Max rows (capped at 25).
`start` post	int	`0`	Offset. Alias: offset.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 1,
    "data": [
        {
            "id": 342,
            "form_name": "Level transition payment",
            "iteam_type": "product",
            "amount": "65"
        }
    ]
}

Count Only

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

{
    "url": "\/app\/PaymentForms.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/PaymentForms.Count",
    "url_domain": "https:\/\/{domain}\/app\/PaymentForms.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "route": "PaymentForms.Count",
        "max_limit": 25
    }
}

Count JavaScript

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

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

JavaScript Example

const token = 'YOUR TOKEN';
const body = new URLSearchParams({ limit: '25' });
const res = await fetch('/app/PaymentForms.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
console.log(await res.json());

Error Example

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