Nutshell CRM

If the get_individual_entity tool is available, it should always be preferred over this tool. If that tool is not available at all, this tool can be used to get information about a single Nutshell entity. Fetches data about an individual Nutshell entity given a valid Nutshell API ID, ex 1-users, returned in JSON format.

fetch

Provided with a report type, return a report on leads from a Nutshell instance. When filtering or sorting, call nutshell_list_entity_field_info once per conversation for leads.

nutshell_leads_report

Gets the custom field values for a specific Nutshell lead, account, or contact. Each field in the response includes its name (title), data type, and current value, so no separate lookup is needed to interpret the results.

get_entity_custom_fields

Returns the fields that can be used to filter or sort a list of companies, people, or leads. Call once per entity type per conversation when filtering or sorting; reuse the result for subsequent calls.

nutshell_list_entity_field_info

Gets a single Nutshell entity or list of specific entities based on their API ID(s)

get_individual_entities

Gets the user that is currently interacting with you. Should be employed when the user is asking questions relating to themselves.

get_user

Provided with an entity type, return a list of those entities from a Nutshell instance. For leads, contacts, or accounts with filters or sorting, call nutshell_list_entity_field_info once per entity type per conversation first. For timelines or event history, use nutshell_events instead — do not pass entityType events.

nutshell_list_entity

Returns a list of entities from a nutshell instance using a saved filter. You MUST call the nutshell_saved_filter tool first to get the saved filter value. If a user is asking about a list of entities, you may want to try this first before using custom filter options.

nutshell_list_entity_from_saved_filter

Returns a list of saved filters from a nutshell instance. A saved filter represents the filter options used to create a list of entities (accounts, contacts, leads). Optional params may include filter to narrow results. Each returned filter has a value for nutshell_list_entity_from_saved_filter.

nutshell_saved_filter

Returns a list of events from a nutshell instance. An event represents a change in Nutshell. For a contact, account, or lead, a list of events is also known as the timeline for that entity. For emails and activities, we only return excerpts. If you are looking for information about one of those events, you'll need to make additional calls to get the full information. Prefer this tool over nutshell_list_entity for timelines. Optional params: entity_id (Nutshell API ID for a timeline); limit (top-level, not nested page); events (opt-in types); filters (payload/creator/emailEntityType); max_id/since_id/max_time/since_time for cursoring.

nutshell_events