POST

User.Basic

Return the logged-in user, organization, folders, statuses, team members, tags, and field settings needed to build Customer and Entries forms. Use data.entries.list to show available entry tabs and send the selected id as entry_id on every Entries route.

Permissions

  • User must be logged in with a valid bearer token.
  • Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

  • Returns the user and organization context needed by UI clients.
  • Returns entry ids/names/settings so the UI can call Entries routes correctly.

Push Service

No socket push is sent because this function only reads user and account settings.

Automation

No automation is run because this function only reads user and account settings.

Special Instructions

  • After login, call User.Basic once and keep its ids/settings in UI state.
  • For Entries screens, show data.entries.list to the user. Each item has id, entry_id, name, name_en, and name_he.
  • When the user selects an entry tab, send that selected id as entry_id to Entries.List, Count, Get, Add, Edit, Update, Delete, or Remove.
  • If an entry has entry_customer.enabled=true, the UI must choose an entry customer from entry_customer.folder_id and send it as entry_cust_id on Entries.Add. If entry_customer.internal_status_id is set, that customer must currently have that internal status.
  • Use data.entries.tabs and data.field_settings.entries to understand the selected tab fields. Row values are sent as data1, data2, data3, etc.

Required Parameters

No body parameters are required for this function.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/User.Basic",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "url_user": "https:\/\/{user}.bull36.com\/app\/User.Basic",
    "url_domain": "https:\/\/{domain}\/app\/User.Basic"
}

Endpoint

POST /app/User.Basic
POST https://{user}.bull36.com/app/User.Basic
POST https://{domain}/app/User.Basic

Sample Output

{
    "success": 1,
    "message": "Basic user data fetched successfully.",
    "data": {
        "user": {
            "id": "47",
            "name": "Eli Demo",
            "email": "[email protected]",
            "owner_id": "47",
            "organization_id": "10",
            "default_folder": "1",
            "language": "he"
        },
        "org": {
            "id": "47",
            "name": "Demo Org",
            "organization_id": "10",
            "user_domain": "eli"
        },
        "settings": {
            "language": "he",
            "default_folder": "1",
            "is_owner": 1,
            "is_member_admin": 0,
            "fields_on_dashboard_folder": [],
            "tabs_group_details": [],
            "hide_common_fields_on_add_edit_customer": []
        },
        "entries": {
            "list": [
                {
                    "id": "7",
                    "entry_id": "7",
                    "name": "Lead data",
                    "name_en": "Lead data",
                    "name_he": "Lead data",
                    "use_customer_for_entry": 1,
                    "entry_customer_folder_id": 12
                }
            ],
            "tabs": [
                {
                    "id": "7",
                    "entry_id": "7",
                    "name": "Lead data",
                    "name_en": "Lead data",
                    "name_he": "Lead data",
                    "fields": {
                        "fld_budget": {
                            "name": "fld_budget",
                            "field_no": 1,
                            "input_type": "number",
                            "label_en": "Budget",
                            "label_he": "Budget"
                        }
                    }
                }
            ],
            "tabs_group_details": []
        },
        "folders": [
            {
                "id": "1",
                "name_en": "New",
                "name_he": "חדש",
                "color": "#2490ef"
            }
        ],
        "file_folders": [
            {
                "id": "12",
                "name_en": "Contracts",
                "name_he": "חוזים"
            }
        ],
        "statuses": {
            "customer": {
                "new": {
                    "name": "New",
                    "color": "#2490ef"
                }
            },
            "internal": [
                {
                    "id": "8",
                    "name_en": "Waiting",
                    "type": "internal_status"
                }
            ],
            "mission_sub_status": [
                {
                    "id": "3",
                    "name_en": "Open"
                }
            ]
        },
        "tags": [
            {
                "id": "5",
                "name": "VIP",
                "color": "#f59e0b"
            }
        ],
        "team_members": [
            {
                "id": "47",
                "name": "Eli Demo",
                "email": "[email protected]",
                "status": "1"
            }
        ],
        "mission_steps": [
            {
                "id": "2",
                "name_en": "Call",
                "color": "#22c55e"
            }
        ],
        "field_settings": {
            "customer": {
                "common_fields": [
                    "name",
                    "phone",
                    "second_phone",
                    "email",
                    "second_email",
                    "company",
                    "source",
                    "website",
                    "password",
                    "note",
                    "address",
                    "city",
                    "folder_id",
                    "status_id",
                    "tag"
                ],
                "extra_fields": [
                    {
                        "name": "vip_level",
                        "type": "select",
                        "label": "VIP Level",
                        "options": [
                            "gold",
                            "silver"
                        ]
                    }
                ],
                "extra_fields_order": [
                    "phone",
                    "email",
                    "vip_level"
                ],
                "hide_common_fields_on_add_edit_customer": [],
                "fields_on_dashboard_folder": [],
                "write_payloads": {
                    "extra_fields": "Send a JSON object keyed by custom field name\/id.",
                    "extra_fields[field_name]": "Alternative form-data style for one custom field value."
                }
            },
            "entries": {
                "tabs": [
                    {
                        "id": "7",
                        "entry_id": "7",
                        "name": "Lead data",
                        "tab_name_en": "Lead data",
                        "tab_name_he": "Lead data",
                        "folders": [
                            "3"
                        ],
                        "status": {
                            "st_open": {
                                "label_en": "Open",
                                "color_name": "#ffa500",
                                "sub_status": ""
                            }
                        },
                        "tab_order": "10",
                        "entry_customer": {
                            "enabled": true,
                            "folder_id": 12,
                            "internal_status_id": 0
                        }
                    }
                ],
                "tabs_group_details": [],
                "allowed_write_fields": [
                    "tab_name_en",
                    "tab_name_he",
                    "tab_name",
                    "folders",
                    "status",
                    "shard_with",
                    "tab_order",
                    "icon",
                    "color",
                    "type",
                    "show_in_dashboard",
                    "show_in_customer",
                    "fields",
                    "fields_json",
                    "custom_fields",
                    "settings"
                ],
                "write_payloads": {
                    "fields": "JSON object keyed by unique field ids. Each field uses input_type (not type), field_no, label_en, and label_he.",
                    "status": "JSON object of status rows keyed by unique ids, with label_en and color_name. Not int 1\/0.",
                    "folders": "JSON array of folder ids, for example [\"3\"].",
                    "custom_fields": "JSON object for custom entry configuration when supported.",
                    "settings": "JSON object for entry UI\/settings when supported."
                }
            },
            "other_custom_fields": {
                "project_custom_fields": [],
                "mission_custom_fields": [],
                "order_custom_fields": [],
                "custom_fields_on_emails": [],
                "pinned_field_on_email": []
            }
        }
    }
}

JavaScript Example

const token = 'YOUR TOKEN';

const res = await fetch('/app/User.Basic', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` }
});

const data = await res.json();
const entries = data.data.entries.list;
const selectedEntry = entries[0];
console.log({ entries, selected_entry_id: selectedEntry && selectedEntry.id });

Error Example

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