get_account | Fetch an account (sales account) by id. |
get_contact | Fetch a contact by id. Optionally embed related data via include: owner, tasks, notes, deals, sales_accounts, etc. |
get_deal | Fetch a deal by id. |
list_account_views | List available account views (filters) with their id and name. Pass a view id to list_accounts to fetch accounts from that view. |
list_accounts | List accounts from a specific view. The view_id comes from list_account_views. Supports pagination and sorting. |
list_contact_views | List available contact views (filters) with their id and name. Pass a view id to list_contacts to fetch contacts from that view. |
list_contacts | List contacts from a specific view. The view_id comes from list_contact_views. Supports pagination (page, per_page up to 100) and sorting (sort: lead_score|created_at|updated_at|open_deals_amount|last_contacted, sort_type: asc|desc). |
list_deal_stages | List all deal stages with their id, name and deal_pipeline_id. Use to pick valid deal_stage_id values when creating or updating a deal. |
list_deal_views | List available deal views (filters) with their id and name. Pass a view id to list_deals to fetch deals from that view. |
list_deals | List deals from a specific view. The view_id comes from list_deal_views. Supports pagination and sorting. |
list_owners | List all users (owners) in the Freshsales account — returns id and name for each. Use to resolve owner_id values for contacts, deals and tasks. |
lookup_by_email | Look up a contact, account or deal by email address. Set f=email and provide the email in q. Use entities to restrict the search (e.g. entities=contact). |
search | Search across contacts, accounts and deals by keyword. Use the include param to narrow results to specific entity types (e.g. include=contact,sales_account,deal). |