Menu

Referência da API · Reports

Temas

reports · themes · 5 operações

GET/v1/reports/themes

List report themes

reports.themes.list

LeituraIdempotenteDesde 2026-11-01

Lists the report themes available to the organization: the four system themes (classic, elegant, playful, bold; first, unless include_system is false) and the organization's own, newest first, in one list paginated by cursor (the system themes count in limit). Each theme has seven hex colors and its fonts. Apply one to a template, report or instance with theme_id + theme_source. Requires view access to Reports.

Escopo
reports:read
Permissão
Ver o módulo
Tool do MCP
reports_themes_listNa superfície completa; na compacta, mb_execute_operation com id: "reports.themes.list".

Custo declarado: até 51 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

limitintegerqueryopcional

How many themes per page (default 50, at most 200).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, to get the next one; omit it for the first page.

include_systembooleanqueryopcional

Include the four system themes first (default true); they count in limit.

Padrão: true

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

curl "https://api.mb-suite.com/v1/reports/themes" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/reports/themes" \
  -H "Authorization: Bearer $MB_TEST_KEY"
GET/v1/reports/themes/{theme_id}

Get a report theme

reports.themes.get

LeituraIdempotenteDesde 2026-11-01

Returns one report theme: a system one (classic, elegant, playful, bold) or the organization's, with its colors and fonts; without source it looks in both. Not found if the id does not exist. Requires view access to Reports.

Escopo
reports:read
Permissão
Ver o módulo
Tool do MCP
reports_themes_getNa superfície completa; na compacta, mb_execute_operation com id: "reports.themes.get".

Custo declarado: até 1 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

theme_idstringrotaobrigatório

The theme id (reports.themes.list): a system one (classic, elegant, playful, bold) or the organization's.

sourceenumqueryopcional

organization or system; omit it to look in both.

Valores: organization, system

Resposta

idstring

Theme id.

namestring

Name.

is_systemboolean

A system theme (read-only).

colorsobject

Colors.

typographyobject

Fonts.

created_atnumber | null

Created (epoch ms); null for system themes.

updated_atnumber | null

Last edited (epoch ms); null for system themes.

created_bystring | null

Uid of who created it.

Erros

Exemplo

curl "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/reports/themes

Create a report theme

reports.themes.create

EscritaDesde 2026-11-01

Creates a report theme of the organization: a name (up to 100 characters), seven colors as #rrggbb (primary, secondary, background, text, heading, border, accent) and the fonts (Inter, Merriweather, Roboto, Playfair Display or Montserrat; an optional separate heading font). Returns the theme id. Requires edit access to Reports.

Escopo
reports:write
Permissão
Editar no módulo
Tool do MCP
reports_themes_createNa superfície completa; na compacta, mb_execute_operation com id: "reports.themes.create".

Custo declarado: até 0 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

namestringcorpoobrigatório

Theme name.

colorsobjectcorpoobrigatório

The theme's colors, all #RRGGBB.

typographyobjectcorpoobrigatório

The theme's fonts.

Resposta

theme_idstring

Erros

Exemplo

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

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/reports/themes" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME",
  "colors": {},
  "typography": {}
}'
PATCH/v1/reports/themes/{theme_id}

Update a report theme

reports.themes.update

EscritaIdempotenteDesde 2026-11-01

Updates the name, the colors (all seven) or the fonts of one of the organization's report themes; everything that uses it changes look. System themes cannot be edited (409 system_theme_read_only). Returns the updated theme. Fields go inside updates. Requires edit access to Reports.

Escopo
reports:write
Permissão
Editar no módulo
Tool do MCP
reports_themes_updateNa superfície completa; na compacta, mb_execute_operation com id: "reports.themes.update".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

theme_idstringrotaobrigatório

The id of one of the organization's own themes (reports.themes.list, is_system false).

updatesobjectcorpoobrigatório

The fields to change.

Resposta

themeobject

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X PATCH "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'
DELETE/v1/reports/themes/{theme_id}

Delete a report theme

reports.themes.delete

IrreversívelDesde 2026-11-01

Deletes one of the organization's report themes; it stays 30 days in the trash. Templates, reports and instances that used it fall back to the default look until it is restored (it comes back with the same id): the dry run says how many use it. System themes cannot be deleted (409 system_theme_read_only). Requires edit access to Reports. Outside the screen it needs a dry run and a confirm_token, or a key with deletion enabled.

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
reports:write e «Permitir exclusões» (reports:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
reports_themes_deleteNa superfície completa; na compacta, mb_execute_operation com id: "reports.themes.delete".

Custo declarado: até 1 leituras e 2 escritas por chamada (contam na cota diária).

Parâmetros

theme_idstringrotaobrigatório

The id of one of the organization's own themes (reports.themes.list, is_system false).

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.

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/reports/themes/{theme_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"