Lists the custom fields the workspace defined for its accounts, in their order: name, slug (the key of the value in each account's custom_fields), type (text, number, select, multiselect, date, daterange, checkbox, user, rating, progress, files…), options of selects, required flag, help text, group and visibility in the table and the drawer. Up to 100 fields. Read the values of one account with child_orgs.custom_fields.get_values.
Escopo
child_orgs:read
Permissão
Ver o módulo
Tool do MCP
child_orgs_custom_fields_listNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.list".
Custo declarado: até 201 leituras e 0 escritas por chamada (contam na cota diária).
Defines a custom field for the workspace's accounts, at the end of the order: name, type, options for select and multiselect, required flag, default value, help text, group and visibility in the table and the drawer. The slug (lowercase letters, digits and underscores) is derived from the name unless given and must be unique in the workspace (custom_field_slug_taken, 409); up to 100 fields (limit_reached, 409, details.resource account_custom_fields). Owners and admins. Returns the field.
Escopo
child_orgs:write
Permissão
Editar no módulo · Só owner, admin
Tool do MCP
child_orgs_custom_fields_createNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.create".
Custo declarado: até 2 leituras e 1 escritas por chamada (contam na cota diária).
Parâmetros
namestringcorpoobrigatório
The field's name as the app shows it (up to 80 characters).
typeenumcorpoobrigatório
The kind of value: text, longtext, number, currency (an amount), currency_code (an ISO 4217 code; currencyCode is accepted too), country, date, datetime, daterange, select or multiselect (with options), url, email, phone, checkbox, user or member (one member of the workspace or the account: the field holds their uid; the two are the same), members (a list of members' uids), rating, progress or files.
The key of the value in each account's custom_fields (lowercase letters, digits and underscores; derived from the name when absent). It cannot change later.
optionsarray<object>corpoopcional
For select and multiselect: the choices (up to 100), each with value, label and an optional color.
is_requiredbooleancorpoopcional
Whether the app marks the field as required.
default_valueanycorpoopcional
The value a new account gets (up to 2 KB, of the field's type).
help_textstringcorpoopcional
A hint shown under the field (up to 300 characters).
group_namestringcorpoopcional
The group the field is shown in, in the account's profile (up to 60 characters).
Changes the name, options, required flag, default value, help text, group, visibility or order of an account custom field; null clears the help text, the group or the default value. The slug and the type do not change (the stored values depend on them). Fields not sent keep their value. Owners and admins. Returns the field.
Escopo
child_orgs:write
Permissão
Editar no módulo · Só owner, admin
Tool do MCP
child_orgs_custom_fields_updateNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.update".
Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).
Parâmetros
field_idstringrotaobrigatório
Custom field definition id (from child_orgs.custom_fields.list).
namestringcorpoopcional
The field's name as the app shows it (up to 80 characters).
optionsarray<object>corpoopcional
For select and multiselect: the choices (up to 100), each with value, label and an optional color. Replaces the whole list.
is_requiredbooleancorpoopcional
Whether the app marks the field as required.
default_valueany | nullcorpoopcional
The value a new account gets (up to 2 KB, of the field's type). null removes it.
help_textstring | nullcorpoopcional
A hint shown under the field (up to 300 characters). null removes it.
group_namestring | nullcorpoopcional
The group the field is shown in, in the account's profile (up to 60 characters). null removes it.
show_in_tablebooleancorpoopcional
Whether the Accounts table shows it as a column.
show_in_drawerbooleancorpoopcional
Whether the account's side panel shows it.
orderintegercorpoopcional
Its position among the account fields (0 = the first); child_orgs.custom_fields.reorder sets the whole order at once.
Deletes the definition of an account custom field. The values the accounts stored under its slug are kept and simply stop being shown; the definition stays 30 days in the trash and, restored, shows them again. Owners and admins. Outside the app it needs a dry run and a confirm_token, except a REST DELETE with a key allowed to delete.
Com uma API key, este DELETE roda direto: o registro fica 30 dias na lixeira e a resposta traz o seu trash_item_id. Com um token OAuth, e pelo MCP, pede dry_run → confirm_token.
Escopo
child_orgs:writee «Permitir exclusões» (child_orgs:delete no OAuth)
Permissão
Editar no módulo · Só owner, admin
Tool do MCP
child_orgs_custom_fields_deleteNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.delete".
Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).
Parâmetros
field_idstringrotaobrigatório
Custom field definition id (from child_orgs.custom_fields.list).
Resposta
oktrue
trash_item_idstring
The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.
trash_item_idsarray<string>
Only when the deletion left more than one copy: all of them, the first being trash_item_id.
trash_expires_atnumber
When the copy leaves the trash for good (epoch ms): 30 days after the deletion.
Sets the order of the account custom fields, shared by everyone in the workspace (columns of the Accounts table and the account drawer): the ids sent go first, in that order; the fields not sent keep their relative order after them. Unknown ids are refused. Owners and admins. Returns every field id with its new position.
Escopo
child_orgs:write
Permissão
Editar no módulo · Só owner, admin
Tool do MCP
child_orgs_custom_fields_reorderNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.reorder".
Custo declarado: até 200 leituras e 200 escritas por chamada (contam na cota diária).
Parâmetros
ordered_idsarray<string>corpoobrigatório
Field ids in the new order. Fields not listed keep their relative order after these.
Returns the values of the account custom fields stored in one account, keyed by slug (only fields defined today; empty fields are absent). Value formats: text as strings, numbers, timestamps in milliseconds for dates, { from, to } for date ranges, option values for selects, member uids for people, and the uploaded files' metadata for files fields. Needs to see the account (members only see their assigned ones).
Escopo
child_orgs:read
Permissão
Ver o módulo
Tool do MCP
child_orgs_custom_fields_get_valuesNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.get_values".
Custo declarado: até 201 leituras e 0 escritas por chamada (contam na cota diária).
Parâmetros
account_idstringrotaobrigatório
Account id: a child organization of this workspace (the ids of platform.orgs.list).
Writes custom field values of one account, keyed by slug (child_orgs.custom_fields.list). By default only the fields sent change and null clears one; with replace: true the account keeps exactly the fields sent. Each new value is validated against its field's type (custom_field_invalid; custom_field_unknown for a slug that does not exist): text, numbers, timestamps in milliseconds for dates, { from, to } for date ranges, option values for selects, uids of workspace members for people, 0–5 for rating and 0–100 for progress. Files are uploaded in the app (custom_field_not_writable). Owners, admins and members, on accounts they can see. Returns the stored values and the slugs that changed.
Escopo
child_orgs:write
Permissão
Editar no módulo · Só owner, admin, member
Tool do MCP
child_orgs_custom_fields_set_valuesNa superfície completa; na compacta, mb_execute_operation com id: "child_orgs.custom_fields.set_values".
Custo declarado: até 202 leituras e 1 escritas por chamada (contam na cota diária).
Parâmetros
account_idstringrotaobrigatório
Account id: a child organization of this workspace (the ids of platform.orgs.list).
custom_fieldsobjectcorpoobrigatório
Values keyed by field slug; null clears a field.
replacebooleancorpoopcional
true: the account keeps exactly the fields sent (the rest are cleared). Default false: only the fields sent change.
