Custom fields

List the account custom fields

child_orgs.custom_fields.list

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.

Scope

child_orgs:read

Permission

View the module

MCP tool

child_orgs_custom_fields_listOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.list".

Declared cost: up to 201 reads and 0 writes per call (they count against the daily quota).

Parameters

No parameters.

Response

Errors

Example

curl "https://api.mb-suite.com/v1/accounts/custom-fields" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/accounts/custom-fields" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create an account custom field

child_orgs.custom_fields.create

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.

Scope

child_orgs:write

Permission

Edit in the module · Only owner, admin

MCP tool

child_orgs_custom_fields_createOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.create".

Declared cost: up to 2 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/accounts/custom-fields" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "type": "text"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/accounts/custom-fields" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "type": "text"
}'

Update an account custom field

child_orgs.custom_fields.update

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.

Scope

child_orgs:write

Permission

Edit in the module · Only owner, admin

MCP tool

child_orgs_custom_fields_updateOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.update".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/accounts/custom-fields/{field_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/accounts/custom-fields/{field_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Delete an account custom field

child_orgs.custom_fields.delete

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.

With an API key, this DELETE runs directly: the record stays 30 days in the trash and the response carries its trash_item_id. With an OAuth token, and through the MCP, it needs dry_run → confirm_token.

Scope

child_orgs:write and “Allow deletions” (child_orgs:delete in OAuth)

Permission

Edit in the module · Only owner, admin

MCP tool

child_orgs_custom_fields_deleteOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.delete".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/accounts/custom-fields/{field_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X DELETE "https://api.mb-suite.com/v1/accounts/custom-fields/{field_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Reorder the account custom fields

child_orgs.custom_fields.reorder

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.

Scope

child_orgs:write

Permission

Edit in the module · Only owner, admin

MCP tool

child_orgs_custom_fields_reorderOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.reorder".

Declared cost: up to 200 reads and 200 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/accounts/custom-fields/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/accounts/custom-fields/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

Get an account's custom field values

child_orgs.custom_fields.get_values

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).

Scope

child_orgs:read

Permission

View the module

MCP tool

child_orgs_custom_fields_get_valuesOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.get_values".

Declared cost: up to 201 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/accounts/{account_id}/custom-fields" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/accounts/{account_id}/custom-fields" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Set an account's custom field values

child_orgs.custom_fields.set_values

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.

Scope

child_orgs:write

Permission

Edit in the module · Only owner, admin, member

MCP tool

child_orgs_custom_fields_set_valuesOn the full surface; on the compact one, mb_execute_operation with id: "child_orgs.custom_fields.set_values".

Declared cost: up to 202 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/accounts/{account_id}/custom-fields" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "custom_fields": {}
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/accounts/{account_id}/custom-fields" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "custom_fields": {}
}'