Referência da API · Organização

Organizações

organizations · orgs · 2 operações

GET/v1/orgsList the organizations this caller can reach GET/v1/orgs/{target_org_id}Get one reachable organization

GET/v1/orgs

List the organizations this caller can reach

platform.orgs.list

LeituraIdempotenteDesde 2026-11-01

The current organization first, then the Accounts (child organizations) of a workspace that the caller can reach: the ones the user is a member of or has access to, narrowed by the credential's child_scope when calling with a key. Archived and deleted Accounts are not listed (child_orgs.accounts.list_with_sources lists the archived ones too). Each row has name, slug, category, tier, enabled_modules (the modules that are on, as the app resolves them), members_count (direct members), created_at, child_org_status (dormant, pending_activation or active; null for a workspace) and billing_mode (parent_managed, parent_pays, self_pays or independent); the row of the current organization also has child_orgs_count (the Accounts of the workspace that exist, archived ones included). For owners and admins each row also has subscription (an API key or OAuth app also needs the child_orgs read scope): the subscription the organization pays itself (status, plan, cancel_at_period_end, current_period_end, trial_end), or null when it pays none (an Account its workspace pays for or manages); members and viewers do not get the field, as in the app. Never Stripe ids, prices or payment methods. Without limit it brings every Account (up to 300); with limit, pages of that many Accounts after the current organization (which comes only in the first page), with has_more and next_cursor. Cost: one read per Account of the workspace within the credential's child_scope (archived and deleted ones included, up to 300), on every page. Module: Organization (organizations), even though the id starts with platform.; any valid credential can read it.

Escopo: organizations:read
Permissão: Ver o módulo
Tool do MCP: platform_orgs_listNa superfície completa; na compacta, mb_execute_operation com id: "platform.orgs.list".

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

Parâmetros

limitintegerqueryopcional

How many Accounts this page brings at most, after the current organization (by default all of them, up to 300).

Padrão: 300

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

Resposta

dataarray<object>

has_moreboolean

True when more Accounts follow: ask again with next_cursor.

next_cursorstring

Pass it as cursor to get the next page.

Erros

invalid_input unknown_field authentication_required scope_insufficient module_access_denied operation_not_found rate_limited quota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/orgs" \
  -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/orgs" \
  -H "Authorization: Bearer $MB_TEST_KEY"

GET/v1/orgs/{target_org_id}

Get one reachable organization

platform.orgs.get

LeituraIdempotenteDesde 2026-11-01

Returns the current organization or one of its Accounts (by target_org_id) with name, slug, category, tier, enabled_modules (the modules that are on, as the app resolves them), members_count (direct members), created_at, child_org_status (dormant, pending_activation or active; null for a workspace) and billing_mode (parent_managed, parent_pays, self_pays or independent); the current organization also has child_orgs_count (the Accounts of the workspace that exist, archived ones included). For owners and admins it also has subscription (an API key or OAuth app also needs the child_orgs read scope): the subscription the organization pays itself (status, plan, cancel_at_period_end, current_period_end, trial_end), or null when it pays none; members and viewers do not get the field, as in the app. Never Stripe ids, prices or payment methods. An archived Account can be read by id. Not found (organization_not_found, param target_org_id) when the organization is not an Account of the current one, it was deleted, the user cannot see it, or the credential's child_scope leaves it out. Cost: one read for an Account; for the current organization, one per Account of the workspace (to count them, up to 300). Module: Organization (organizations), even though the id starts with platform.; any valid credential can read it.

Escopo: organizations:read
Permissão: Ver o módulo
Tool do MCP: platform_orgs_getNa superfície completa; na compacta, mb_execute_operation com id: "platform.orgs.get".

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

Parâmetros

target_org_idstringrotaobrigatório

The organization to read: the current one or one of its Accounts (an id from platform.orgs.list).

Resposta

idstring

The organization id (the org_id other operations take; for an Account, the account_id).

namestring

The organization's name.

slugstring

Its address in the app (mb-suite.com/<slug>/…).

categoryenum

agency: a workspace that manages Accounts; enterprise: an Account of a workspace or a standalone organization.

Valores: agency, enterprise

parent_org_idstring | null

For an Account, the id of its workspace; null for a workspace or a standalone organization.

statusstring

active, archived or suspended.

tierstring

The API usage tier of the organization's own plan (trial, starter, growth, scale or enterprise): the one platform.me limits uses for a call made in it. It is not the subscription plan (that is subscription.plan); an Account the workspace pays for is called with the workspace's limits.

enabled_modulesarray<string>

The modules that are on in the organization, as the app resolves them: its own, the base ones that are always on, the ones an Account inherits from its workspace, and only those MB Suite has released for it (active or under maintenance). Module ids, as organizations.modules.list names them.

members_countnumber

Its direct members (the workspace's team that reaches an Account is not counted).

is_currentboolean

True for the organization of the call (the first row of the list).

created_atnumber | null

When the organization was created (epoch ms); null if MB Suite does not have the date.

child_org_statusstring | null

For an Account: dormant (managed by the workspace, no billing of its own), pending_activation (invited to pay for itself, not paid yet) or active (activated with its own modules and users). Null for a workspace. The same value as child_orgs.accounts.list_with_sources.

billing_modestring

Who pays: parent_managed (a dormant Account), parent_pays (the workspace pays for the Account), self_pays (the Account pays its own subscription) or independent (a workspace or standalone organization).

child_orgs_countnumber

The Accounts of the organization that exist (active and archived; deleted ones do not count), within the credential's child scope: counted for the current organization, 0 for an Account.

subscriptionobject | null

Only for owners and admins (absent for members and viewers, as in the app's Subscription and Partners pages), and for an API key or OAuth app only when it also has the child_orgs read scope: the subscription the organization pays itself, with status, plan and dates; null when it pays none (an Account the workspace pays for or manages). Never Stripe ids, prices, amounts or payment methods.