MB SuiteMB Suite
Menu

API reference · Vault

Shares

vault · shares · 2 operations

GET/v1/vault/sharesPOST/v1/vault/shares/{share_id}/revoke
GET/v1/vault/shares

List the vault's secure shared links

vault.shares.list

ReadIdempotentSince 2026-11-01

Lists the secure links that share Vault credentials outside the team (Share access), newest first, paginated by cursor (limit up to 200), of the chosen scope: active (default; still open) or closed (revoked, used, blocked after 10 wrong keys, or expired). Each link: the credentials it includes (item_ids, item_titles), client account, status, expires_at, max_opens (1 = one time), opens, failed_attempts, last_opened_at, the recipient and note the creator wrote down, requires_key, who created it and when. Everyone with access to the Vault sees the team's links. It never returns the link itself, its code or its key: the URL is a bearer link and is only copied from the app. A link past its expiry is reported (and saved) as expired, and the page is completed reading up to 400 links. Requires view access to the Vault.

Scope
vault:read
Permission
View the module
MCP tool
vault_shares_listOn the full surface; on the compact one, mb_execute_operation with id: "vault.shares.list".

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

Parameters

limitintegerqueryoptional

How many items this page brings at most (see the maximum and the default in the schema).

Default: 50

cursorstringqueryoptional

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

scopeenumqueryoptional

active (default) or closed (revoked, used, blocked or expired).

Values: active, closed · Default: "active"

Response

dataarray<object>
has_moreboolean
next_cursorstring

Errors

invalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Example

curl "https://api.mb-suite.com/v1/vault/shares" \
  -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/vault/shares" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/vault/shares/{share_id}/revoke

Revoke a secure shared link

vault.shares.revoke

WriteIdempotentSince 2026-11-01

Closes a secure shared link at once: from now on it shows the neutral «not available» page and the credentials' «shared until» badge is recalculated. Only its creator, an owner or an admin can revoke it (vault_link_not_owner, 403). A revoked link cannot be reopened: create a new one in the app. Idempotent: on a link that is already closed (revoked, used, blocked or expired) nothing changes (changed=false). Returns the link. Requires edit access to the Vault.

Scope
vault:write
Permission
Edit in the module
MCP tool
vault_shares_revokeOn the full surface; on the compact one, mb_execute_operation with id: "vault.shares.revoke".

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

Parameters

share_idstringpathrequired

The shared link's id (from vault.shares.list).

Response

shareobject
changedboolean

Errors

vault_share_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Example

curl -X POST "https://api.mb-suite.com/v1/vault/shares/{share_id}/revoke" \
  -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 POST "https://api.mb-suite.com/v1/vault/shares/{share_id}/revoke" \
  -H "Authorization: Bearer $MB_TEST_KEY"