AI Image

Close CRM

API Documentation

Close CRM is a uniquely tailored tool for managing customer relationships with an intricate yet user-focused structure. Characterized by its ability to offer complex data insight in an easy-to-understand format, this tool helps businesses unlock new avenues to grow and engage their customer base. It enables users to delve deep into lead data through smart views and lead statuses, turning potential contacts into actionable opportunities. One of the key elements that sets Close CRM apart is the way it handles various components within its framework—‘lead’ objects, loaded with supplementary information including multiple ‘contact’, ‘opportunity’, ‘task’, ‘activity’, and ‘address’ objects. Additionally, the tool provides expanded features for each activity type, be it a call, email, meeting, note or SMS. It also includes a 'custom_activity' category that brings flexibility to the already versatile tool. It's worth mentioning that despite its sophistication, Close CRM still remains intuitive to use, strictly adhering to its field schema for search queries. All in all, Close CRM expertly interweaves a wide array of functionalities into one comprehensive package, enabling businesses to foster better customer relationships and bolster their growth.




Example Prompts


"Give me the details of organization and list of users."


"Can you show me the information about groups?"


"I want to see all the statuses of leads."


"Display all the statuses of opportunities."


"Show me the list of all smart views."


"Give me the custom fields for leads."


"Can you show me the custom fields for contacts?"


"I want to see the custom fields for opportunities."


"Display the details of custom field with id CF


"Show me a list of all custom activity types."


"Search for leads with the name 'John Doe'."


"Search for contacts with the email ''."


"Can you search for opportunities with the status 'Open'?"


"Give me the summary of lead with id LEAD


"Show me the activity details of lead with id LEAD


"Can you filter the activities of lead LEAD


"Filter the activities of lead LEAD

Description for AI

Not all leads are customers, accounts, or potential contacts, always look for matching smart views and lead statuses when unclear terms are used.

lead objects may contain multiple contact, opportunity, task, activity, and address objects. contact objects do not have addresses. Activities may have different types, such as call, note, meeting, sms, email.

Any object contains the following fields: date_created, date_updated, created_by, updated_by.

lead objects contain the following fields: name, status_id, url.

contact objects contain the following fields: name, title, phone, email, url.

address objects contain the following fields: type, address_1, address_2, city, state, zipcode, country. Wrap addresses in a single related address query.

opportunity objects contain the following fields: status_id, status_type (active, won, or lost), close_date, confidence, value, period, note.

task objects contain the following fields: type, assigned_to, is_complete, text, date. Tasks are meant to be completed by sales people and not by leads.

All activities contain the following fields: user_or_group_id, contact_id, type.

call activities also contain: call_method, disposition, cost, duration (seconds), direction, local_phone, remote_phone.

email activities also contain: status, direction, envelope, subject, body_text, sequence_id, sequence_name.

meeting activities also contain: title, location, source, status, attendees, duration, starts_at, ends_at, is_recurring.

note activities also contain: note

sms activities also contain: status, direction, local_phone, remote_phone, text, attachments.

custom_activity contain custom_activity_type_id, status (draft or published). To search custom activities, use a custom_activity related query and filter by custom_activity_type_id, and add any further queries such as a text query inside the related query. Custom activities do not include activity types specified above.

All dates in ISO format. Opportunity values in cents.

Search for activity counts on leads using "num_" + plural, e.g. "num_calls", "num_incoming_calls", "num_outgoing_calls" "num_emails", "num_received_emails", "num_sent_emails".

Search for computed fields on leads using "first" or "last" prefix, the object type, and then the field name, e.g. "last_call_created".

To search for leads that haven't been contacted recently, use a negated related query with related_types set to call, sms, and email. The related query should have a gt date_created clause and a field query with values for each user or group ID, if given.

To search for multiple status values, put them all in a single values param.

When filtering by multiple users that are part of a group, you must use the group ID inside the search query instead of the user ID.

Search for contact info on leads using "num_email_addresses", "num_phone_numbers" etc.

You must strictly follow the field schema for search queries.

If the user searches for multiple fields related to the same object, you must wrap all the conditions in the same related query, unless the user explicitly states otherwise.

To search for activities, use their type name, such as call. Do not search for activity directly.

Never use user names, smart view names, status names, or custom field names in queries, always use IDs. Do not alter, prefix, or invent IDs, field names, or field values. Do not add 'custom.' prefix to IDs. Do not use IDs you have not previously seen. Do not expose IDs to the user unless they ask for it.

Always use the info endpoints to fetch IDs for fields or terms not explicitly mentioned in the prompt before performing a search. Always use the info endpoints to fetch information about the org, users, statuses, smart views, and custom fields before performing a search.

To search for won, lost, or active opportunities, use the status_type field directly.

If a search returns a results_url, you must return it to the user, even if there are no results.

If you receive an error about an invalid ID, refetch the corresponding info endpoint and use the correct ID.

Don't explain the steps you're performing.

When asked to summarize a lead, or create content like drafting an email for a lead, use the leadSummary and leadActivitySummary endpoints, and personalize the content.

Similar Plugins and Alternatives