×

Tool reference · Schema and discovery

get_properties EngageBay MCP tool

Look up the exact field names, data types, and allowed values for any EngageBay record type — including your own custom fields — before you search, filter, or ask your assistant a question that depends on a specific field.

Category
Schema and discovery
Permission needed
Per object type
Access type
Read-only
On this page

What this tool does

Every record in EngageBay — a contact, a deal, a task — is built from a set of fields, such as “Lead Score” or “Renewal Date.” The name you see on screen (the label) is often different from the name EngageBay stores internally (the key), and it's the key that any search or filter actually needs.

get_properties returns the full list of fields for a given record type, along with each field's internal key, its data type (text, number, date, dropdown, and so on), and — for dropdown or multi-select fields — the exact set of values it will accept. This includes both EngageBay's built-in fields and any custom fields your team has created.

Think of it as the dictionary your assistant checks before it writes a filter. You won't normally need to call this yourself — your assistant uses it automatically whenever a request depends on knowing a field's real name or accepted values — but it helps to understand what's happening behind the scenes, especially if a search comes back empty or a filter is rejected.

What you can ask

“What fields are available on a contact record?”

“Do we have a custom field for renewal date on deals? What is it called internally?”

“What values can the Lead Source dropdown take?”

“Is the deal Priority field something I can filter on?”

Once you know a field's key and accepted values, use search_crm_objects or count_crm_objects to actually query records with that field. See the filter syntax on the search_crm_objects page.

More tools

Use get_properties from your AI tool

Connect your AI tool to the EngageBay MCP server and ask in plain language — it calls the right tool for you.

This website uses cookies to ensure you get the best experience on our website. Learn more about EngageBay's legal policies