Contacts Tools

Search Contacts

Find people, organizations, clients, and leads in the CRM. Put a person's or company's name in contact_name, and use the dedicated fields for email, phone, CPF, or CNPJ. Without filters, returns up to 20 active non-lead contacts, ordered by most recently updated. Read-only.

get/v1/mcp/tool/contacts

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/mcp/tool/contacts
  • Auth: API key in header X-Imobzi-Secret

Query parameters

search_textstring nullable

General free-text search across indexed contact fields. Use it for a broad query or a public contact code. When the user provides a known name, email, phone, CPF, or CNPJ, prefer the corresponding dedicated field.

contact_namestring nullable

Partial or complete name of a person or organization, matched without case or diacritic sensitivity. Use this field whenever a name is the search criterion. If an exact search returns no records and this is the only identifier, the tool may return similar names. Examples: 'Tiago', 'Maria Silva', 'Construtora ABC'.

contact_emailstring nullable

Exact contact email, matched case-insensitively.

contact_phonestring nullable

Contact phone with or without punctuation, area code, and country code. Formatting is ignored and the value must contain at least eight digits.

contact_legal_identificationstring nullable

Contact CPF or CNPJ with or without formatting.

contact_type'person' | 'organization' | 'all' nullable

Filter by entity type. Use 'person' for individuals, 'organization' for companies, or 'all' to include people, organizations, and leads. Without this field, the normal contact search excludes leads.

contact_status'active' | 'inactive' | 'all' nullable

Filter by activation status. Use 'active', 'inactive', or 'all'. Defaults to 'active'.

is_leadboolean nullable

Set to true to return only leads; this takes precedence over contact_type. Leave it unset for a normal contact search, which excludes leads by default.

tagsstring nullable

Comma-separated tags used to filter contacts. Multiple tags are matched with OR semantics. Example: 'client,vip'.

manager_namestring nullable

Name or partial name of the manager responsible for the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. When the user asks for their own contacts, leave this field empty and set requesting_user_only=true. Examples: 'Maria', 'Carlos Souza'.

manager_emailstring nullable

Exact email of the manager responsible for the contact. Prefer this over manager_name when available because it avoids name ambiguity.

smart_list'shared_with_me' | 'shared_with_others' | 'without_manager' | 'without_email' | 'without_phone' | 'with_deal' | 'without_deal' | 'favorites' | 'pending' | 'out_of_date' | 'out_of_date_90_days' | 'new_contacts' | 'birthdays_all' | 'birthdays_only_mine' | 'my_contacts' nullable

Predefined contact filter. Use: 'shared_with_me' or 'shared_with_others' for sharing; 'without_manager', 'without_email', or 'without_phone' for missing data; 'with_deal' or 'without_deal' for deal linkage; 'favorites' for favorites; 'pending' for pending review; 'out_of_date' for contacts not updated in 365 days; 'out_of_date_90_days' for 90 days; 'new_contacts' for contacts created in the last 30 days; 'birthdays_all' or 'birthdays_only_mine' for today's birthdays; and 'my_contacts' for contacts owned by the requesting user.

requesting_user_onlyboolean nullable

Set to true when the user refers to their own contacts using phrases such as 'meus contatos', 'meus clientes', 'meus leads', or 'contatos que eu tenho'. When smart_list is omitted, this applies smart_list='my_contacts'. Do not set it when the user asks about another manager's contacts.

create_period'today' | 'this_week' | 'this_month' | 'last_month' | 'last_three_months' | 'current_year' | 'last_year' nullable

Filter by contact creation date. Allowed values: 'today', 'this_week', 'this_month', 'last_month', 'last_three_months', 'current_year', and 'last_year'. Example: 'contatos criados esta semana' → create_period='this_week'.

cursorstring nullable

Opaque pagination cursor. Send it only when a cursor was supplied by external context; do not invent one or send it on the first request. The current MCP tool response does not expose the next cursor.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.