Beezr API

Find the module table name

In the Designer, look at the module card. Its table name sits under the module name. Send that table name as module, for example cm_equipment_requests_base.

The display name isn't the table name. If a call returns MODULE_NOT_FOUND, copy the table name again.

Find field System names

Open Designer → module → Fields. Copy the field's System name. Use these names in data, fields, filters and sort. For example, a field may use needed_by.

Unknown field names in write data are ignored. If no fields match, the API returns INVALID_DATA. An invalid filter field returns INVALID_FILTER; if no sort field is valid, the API returns INVALID_SORT.

Find a record id

The record's id is an integer: the value of the module's key field. Query and get return id; keep it for update, delete and file downloads.

Hand the names to your assistant

To hand these names to an AI assistant, paste them into Brief your AI assistant, with field types if you have them. Don't include an API key.