Timeline Tools

Search Timeline Items

Find historical activity attached to a person, organization, property, active lease, or deal/card. Requires an identifier for the parent entity and returns up to 50 recent items. Use search_calendars for scheduled or future calendar items. Read-only.

get/v1/mcp/tool/timelines

Request

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

Query parameters

parent_type'person' | 'organization' | 'property' | 'lease' | 'deal' nullable

Type of entity whose timeline will be searched. It may be inferred when identifiers are provided for exactly one entity category. For lease, provide a property identifier so the tool can find its active lease.

contact_namestring nullable

Partial or complete name of a person or organization.

contact_emailstring nullable

Exact contact email address, matched case-insensitively.

contact_phonestring nullable

Contact phone number; common formatting variations are accepted.

contact_codestring nullable

Public CRM contact code, for example 289 or C-289.

property_codestring nullable

Complete public property code, for example AP-001.

property_addressstring nullable

Partial or complete property address used to resolve the parent property.

deal_codeinteger nullable

Numeric deal/card code, for example 653. Provide pipeline_group_name with a numeric code. Use deal_code_raw instead when the code includes a prefix.

deal_code_rawstring nullable

Deal/card code exactly as provided, for example VL-1491, AVA-12, or 653. Use this field for a prefixed code and preserve the prefix and hyphen. The tool resolves its pipeline automatically; do not split it into deal_code and pipeline_group_name.

pipeline_group_namestring nullable

Display name of the deal/card pipeline. Provide it with a numeric deal_code; omit it when deal_code_raw contains a prefixed code.

timeline_type'all' | 'note' | 'email' | 'task' | 'call' | 'visit' | 'whatsapp' | 'deal' | 'lead' | 'system' | 'document' | 'property_review' | 'lease_status' | 'checklist' | 'association' | 'revision' | 'property_reserve' nullable

Filter by timeline item type. Omit it or use all to return every type.

search_textstring nullable

Phrase-prefix search across item content, title, and description. Use an excerpt that appears at the beginning of the relevant phrase.

start_atstring nullable

Inclusive start date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing.

end_atstring nullable

Inclusive end date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing.

cursorstring nullable

Cursor returned by the previous search response for the next page.

Response

Successful Response

unknown required

Changes

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