Meus leads · CRM · Referência da API | Desenvolvedores do MB Suite

GET/v1/crm/my-leads

List an owner's deals and prospects with everything needed to work them

crm.my_leads.list

LeituraIdempotenteDesde 2026-11-01

Lists in one paginated read the deals and the live prospects (new or reviewing) of one owner, by default the caller, each already joined with what you need to work the lead: the primary person (name, email, phone, country, person labels, do_not_contact, unsubscribed_at, bounced_at, whatsapp_unreachable), the company (name, domain, website, country, industry), the pipeline and stage names (prospects: their interest, the inbox status), the labels, the next step (the earliest pending task, call or meeting), the next meeting (a pending meeting in the future, with its booking_id and link when it comes from a booking), last_activity_at, last_inbound_at and last_outbound_at across all channels (the channel of the last contact is not stored), the action state, and per messaging channel (whatsapp, instagram, facebook, tiktok) the person's most recent conversation with its reply window (open, human_agent, closed or no_window) and when it closes; WhatsApp also says the line. Deals come first, most recently moved first (open by default; deal_status won, lost or all), then prospects, newest first; kinds limits it to one of the two. Follow next_cursor until has_more is false (limit up to 200). Archived deals and merged duplicates are skipped, so a page can bring fewer than limit while has_more is true. Pass owner_id to read another member's or an AI agent's leads: it needs view_all_deals (owners, admins, crm admins, sales managers and members without a restricted scope); a viewer or a seller with restricted scope gets 403 crm_action_denied. Read only, about 3 to 5 reads per lead returned. Use crm.deals.get or crm.persons.context to go deeper into one lead. With LinkedIn or TikTok, their terms limit it through the API and the MCP: what they do not allow answers 403 platform_terms_restricted, and their records are left out of the response (the permissions guide lists what each platform allows).

Escopo: crm:read
Permissão: Ver o módulo · Ação do CRM: view_own_deals
Tool do MCP: crm_my_leads_listNa superfície completa; na compacta, mb_execute_operation com id: "crm.my_leads.list".

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

Parâmetros

limitintegerqueryopcional

How many leads this page brings at most (default 20, up to 200; each lead carries its person, company, next step and channels, about 2 KB).

Padrão: 20

cursorstringqueryopcional

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

owner_idstringqueryopcional

Whose leads: a member's user id (members.members.list or crm.team.list) or an AI position's ai-… id (crm.ai_team.positions.list). Without it, the caller's. One that is not a member nor an AI position of the organization is owner_not_found.

kindsarray<enum>queryopcional

deal, prospect or both (default both).

Valores: deal, prospect

deal_statusenumqueryopcional

The status of the deals (default open). Prospects are always the live ones: new and reviewing.

Valores: open, won, lost, all · Padrão: "open"

Resposta

dataarray<object>

has_moreboolean

next_cursorstring

Erros

crm_action_denied 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/crm/my-leads" \
  -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/crm/my-leads" \
  -H "Authorization: Bearer $MB_TEST_KEY"