> For a complete page index, fetch https://developer.close.com/llms.txt # Advanced Filtering Fields Use these fields in [Advanced Filtering](/api/resources/advanced-filtering) queries as a `regular_field`, with the `object_type` of the section they're listed in, e.g. `{"type": "regular_field", "object_type": "contact", "field_name": "title"}`. A field's `object_type` must match the type of the objects being filtered. To filter by fields of a related object, use a `has_related` query. The value type of a field decides which [condition](/api/resources/advanced-filtering#field-conditions) to use. For `… ID` fields, use a `reference` condition with that ID type as the `reference_type`, e.g. `user`. Custom fields aren't listed here. Filter by them with a `custom_field` that references the custom field's ID. This list is generated from Close's search fields and kept up to date automatically. ## Leads, Contacts & Opportunities ### `lead` | Field | Description | Value type | | ---------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `addresses_count` | Total number of addresses | integer | | `all_urls_count` | Total number of URLs | integer | | `avg_annual_active_opportunity_value` | Opportunity value - average annual active | number | | `avg_annual_lost_opportunity_value` | Opportunity value - average annual lost | number | | `avg_annual_opportunity_value` | Opportunity value - average annual | number | | `avg_annual_won_opportunity_value` | Opportunity value - average annual won | number | | `avg_annualized_active_opportunity_value` | Opportunity value - average annualized active | number | | `avg_annualized_lost_opportunity_value` | Opportunity value - average annualized lost | number | | `avg_annualized_opportunity_value` | Opportunity value - average annualized | number | | `avg_annualized_won_opportunity_value` | Opportunity value - average annualized won | number | | `avg_monthly_active_opportunity_value` | Opportunity value - average monthly active | number | | `avg_monthly_lost_opportunity_value` | Opportunity value - average monthly lost | number | | `avg_monthly_opportunity_value` | Opportunity value - average monthly | number | | `avg_monthly_won_opportunity_value` | Opportunity value - average monthly won | number | | `avg_one_time_active_opportunity_value` | Opportunity value - average one time active | number | | `avg_one_time_lost_opportunity_value` | Opportunity value - average one time lost | number | | `avg_one_time_opportunity_value` | Opportunity value - average one time | number | | `avg_one_time_won_opportunity_value` | Opportunity value - average one time won | number | | `call_notes_count` | Number of calls with notes | integer | | `call_recordings_count` | Number of recordings | integer | | `call_voicemails_count` | Number of voicemails | integer | | `calls_over_60s_count` | Calls over 60s | integer | | `calls_over_60s_duration` | Calls over 60s duration | integer | | `canceled_meetings_duration` | Canceled meetings duration | integer | | `completed_meetings_duration` | Completed meetings duration | integer | | `contact_ids` | Contacts | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `declined_by_lead_meetings_duration` | Declined by lead meetings duration | integer | | `declined_by_org_meetings_duration` | Declined by org meetings duration | integer | | `declined_meetings_duration` | Declined meetings duration | integer | | `description` | Description | text | | `display_name` | Name | text | | `email_first_opened` | Date of first email open | datetime | | `email_last_opened` | Date of latest email open | datetime | | `emails_opened_count` | Number of opened emails | integer | | `first_actual_email_subject` | First actual email - Subject | text | | `first_call_agent_config_id` | First call - Agent Config | `agent_config` ID | | `first_call_any_agent` | First call - AI Agent | `any_agent` ID | | `first_call_created` | Date of first call | datetime | | `first_call_direction` | First call - Direction | one of `inbound`, `outbound` | | `first_call_disposition` | First call disposition | one of `no-answer`, `answered`, `vm-answer`, `vm-left`, `busy`, `blocked`, `error`, `abandoned` | | `first_call_duration` | First call - Duration | integer | | `first_call_note` | First call note | text | | `first_call_outcome_id` | First call - Outcome | `outcome` ID | | `first_call_updated` | First updated call date | datetime | | `first_call_updated_by` | First call - Updated by | `user` ID | | `first_call_user` | First call - User | `user` ID | | `first_communication_date` | First communication - Date | datetime | | `first_communication_direction` | First communication - Direction | one of `incoming`, `outgoing` | | `first_communication_type` | First communication - Type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `first_communication_user_id` | First communication - User | `user` ID | | `first_completed_meeting_outcome_id` | First completed meeting - Outcome | `outcome` ID | | `first_created_source` | First created source | one of `ui`, `api`, `import`, `clipper`, `email`, `suggestion`, `segment-integration`, `customerio-integration`, `calendly-integration`, `ai`, `whatsapp`, `webform` | | `first_email` | First email - Date | datetime | | `first_email_attachments` | First email - Attachment count | integer | | `first_email_bcc` | First email - BCC | text | | `first_email_cc` | First email - CC | text | | `first_email_created` | First email - Date created | datetime | | `first_email_direction` | First email - Direction | one of `incoming`, `outgoing` | | `first_email_from` | First email - From | text | | `first_email_opened` | First email - Open date | datetime | | `first_email_opens` | First email - Opens count | integer | | `first_email_subject` | Earliest email subject | text | | `first_email_template` | First email - Template | `email_template` ID | | `first_email_to` | First email - To | text | | `first_email_user` | First email - User | `user` ID | | `first_emailed` | First email - Recipient | text | | `first_emailed_template` | First templated email - Template | `email_template` ID | | `first_incoming_call_date` | First incoming call - Date | datetime | | `first_incoming_email_date` | First incoming email - Date received | datetime | | `first_incoming_email_user_id` | First incoming email - User | `user` ID | | `first_incoming_sms_date` | First incoming SMS - Date | datetime | | `first_lead_status_change_date` | First lead status change - Date | datetime | | `first_lead_status_change_new_status` | First lead status change - New status | `status.lead` ID | | `first_lead_status_change_old_status` | First lead status change - Old status | `status.lead` ID | | `first_note_by` | First note - Created by | `user` ID | | `first_note_created` | First note - Date | datetime | | `first_note_updated` | First note - Date updated | datetime | | `first_note_updated_by` | First note - Updated by | `user` ID | | `first_note_user` | First note - User | `user` ID | | `first_opportunity_created_date_created` | First opportunity - Date created | datetime | | `first_opportunity_status_change_date` | First opportunity status change - Date | datetime | | `first_opportunity_status_change_new_pipeline` | | `status.opportunity` ID | | `first_opportunity_status_change_new_status` | First opportunity status change - New status | `status.opportunity` ID | | `first_opportunity_status_change_old_pipeline` | | `status.opportunity` ID | | `first_opportunity_status_change_old_status` | First opportunity status change - Old status | `status.opportunity` ID | | `first_opportunity_updated_date_updated` | First opportunity - Date updated | datetime | | `first_opportunity_won_date_won` | First won opportunity date | date | | `first_outgoing_call_date` | First outgoing call - Date | datetime | | `first_outgoing_email_date` | First outgoing email - Date sent | datetime | | `first_outgoing_email_user_id` | First outgoing email - User | `user` ID | | `first_outgoing_sms_date` | First outgoing SMS - Date | datetime | | `first_received_sms_date` | First received SMS date | datetime | | `first_sent_sms_date` | First sent SMS date | datetime | | `first_sms_created` | First SMS created | datetime | | `first_sms_date` | First SMS date | datetime | | `first_sms_direction` | First SMS - Direction | one of `inbound`, `outbound` | | `first_sms_text` | First SMS text | text | | `first_sms_user` | First SMS - User | `user` ID | | `first_updated_note_updated` | First updated note - Date updated | datetime | | `first_voicemail_duration` | First voicemail - Duration | integer | | `in_progress_meetings_duration` | In-progress meetings duration | integer | | `last_activity_date` | Latest activity date | datetime | | `last_activity_user_id` | Latest activity user | `user` ID | | `last_actual_email_subject` | Last actual email - Subject | text | | `last_call_agent_config_id` | Last call - Agent Config | `agent_config` ID | | `last_call_any_agent` | Last call - AI Agent | `any_agent` ID | | `last_call_created` | Last call - Date | datetime | | `last_call_direction` | Last call - Direction | one of `inbound`, `outbound` | | `last_call_disposition` | Last call - Disposition | one of `no-answer`, `answered`, `vm-answer`, `vm-left`, `busy`, `blocked`, `error`, `abandoned` | | `last_call_duration` | Last call duration | integer | | `last_call_note` | Last call note | text | | `last_call_outcome_id` | Last call - Outcome | `outcome` ID | | `last_call_updated` | Last updated call date | datetime | | `last_call_updated_by` | Last call - Updated by | `user` ID | | `last_call_user_id` | Last call - User | `user` ID | | `last_communication_date` | Last communication - Date | datetime | | `last_communication_direction` | Last communication - Direction | one of `incoming`, `outgoing` | | `last_communication_type` | Last communication - Type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `last_communication_user_id` | Last communication - User | `user` ID | | `last_complete_task_due_date` | Last completed task - Due date | datetime | | `last_complete_task_updated` | Last completed task - Date updated | datetime | | `last_completed_meeting_duration` | Last completed meeting - Duration | integer | | `last_completed_meeting_ends_at` | Last completed meeting - End time | datetime | | `last_completed_meeting_is_recurring` | Last completed meeting - Is recurring | boolean | | `last_completed_meeting_location` | Last completed meeting - Location | text | | `last_completed_meeting_note` | Last completed meeting - Event notes | text | | `last_completed_meeting_num_participants` | Last completed meeting - Number of participants | integer | | `last_completed_meeting_outcome_id` | Last completed meeting - Outcome | `outcome` ID | | `last_completed_meeting_source` | Last completed meeting - Source | one of `calendar`, `manual` | | `last_completed_meeting_starts_at` | Last completed meeting - Date | datetime | | `last_completed_meeting_status` | Last completed meeting - Status | one of `upcoming`, `in-progress`, `completed`, `canceled`, `declined-by-org`, `declined-by-lead` | | `last_completed_meeting_title` | Last completed meeting - Title | text | | `last_completed_meeting_users` | Last completed meeting - User | `user` ID | | `last_email_attachments` | Last email - Attachment count | integer | | `last_email_bcc` | Last email - BCC | text | | `last_email_cc` | Last email - CC | text | | `last_email_created` | Last email - Date created | datetime | | `last_email_date` | Last email - Date | datetime | | `last_email_direction` | Last email - Direction | one of `incoming`, `outgoing` | | `last_email_from` | Last email - From | text | | `last_email_last_open_date` | Last email - Date opened | datetime | | `last_email_opens_count` | Last email - Number of opens | integer | | `last_email_subject` | Latest email subject | text | | `last_email_template_id` | Last email - Email Template used | `email_template` ID | | `last_email_to` | Last email - To | text | | `last_email_user` | Last email - User | `user` ID | | `last_emailed` | Last email recipient | text | | `last_emailed_template` | Last emailed template | `email_template` ID | | `last_incoming_call_date` | Last incoming call - Date incoming | datetime | | `last_incoming_communication_date` | Latest incoming communication date | datetime | | `last_incoming_email_date` | Last incoming email - Date received | datetime | | `last_incoming_email_user_id` | Last incoming email - User | `user` ID | | `last_incoming_sms_date` | Last incoming SMS - Date | datetime | | `last_lead_status_change_date` | Date | datetime | | `last_lead_status_change_new_status` | New status | `status.lead` ID | | `last_lead_status_change_old_status` | Previous status | `status.lead` ID | | `last_note_by` | Last note - Created by | `user` ID | | `last_note_created` | Last note - Date | datetime | | `last_note_updated` | Last note - Date updated | datetime | | `last_note_updated_by` | Last note - Updated by | `user` ID | | `last_note_user` | Last note - User | `user` ID | | `last_opportunity_created_date_created` | Last opportunity - Date created | datetime | | `last_opportunity_status_change_date` | Last opportunity status change - Date | datetime | | `last_opportunity_status_change_new_status` | Last opportunity status change - New status | `status.opportunity` ID | | `last_opportunity_status_change_old_status` | Last opportunity status change - Previous status | `status.opportunity` ID | | `last_opportunity_updated_date_updated` | Last opportunity - Date updated | datetime | | `last_opportunity_won_date_won` | Last won opportunity date | date | | `last_outgoing_call_date` | Last outgoing call - Date outgoing | datetime | | `last_outgoing_communication_date` | Latest outgoing communication date | datetime | | `last_outgoing_email_date` | Last outgoing email - Date sent | datetime | | `last_outgoing_email_user_id` | Last outgoing email - User | `user` ID | | `last_outgoing_sms_date` | Last outgoing SMS - Date | datetime | | `last_received_sms_date` | Last received SMS - Date received | datetime | | `last_sent_sms_date` | Last sent SMS - Date sent | datetime | | `last_sms_created` | Last SMS created | datetime | | `last_sms_date` | Last SMS - Date | datetime | | `last_sms_direction` | Last SMS - Direction | one of `inbound`, `outbound` | | `last_sms_text` | Last SMS text | text | | `last_sms_user` | Last SMS - User | `user` ID | | `last_task_created` | Last task - Date created | datetime | | `last_task_creator` | Last task - Created by | `user` ID | | `last_task_due` | Last task - Due date | datetime | | `last_task_text` | Last task - Text | text | | `last_task_updated` | Last task - Date updated | datetime | | `last_task_updated_by` | Last task - Updated by | `user` ID | | `last_updated_note_updated` | Last updated note - Date updated | datetime | | `last_voicemail_duration` | Last voicemail duration | integer | | `longest_call_duration` | Longest call duration | integer | | `longest_recording_duration` | Longest recording duration | integer | | `longest_voicemail_duration` | Longest voicemail duration | integer | | `max_annual_active_opportunity_value` | Opportunity value - largest annual active | number | | `max_annual_lost_opportunity_value` | Opportunity value - largest annual lost | number | | `max_annual_opportunity_value` | Opportunity value - largest annual | number | | `max_annual_won_opportunity_value` | Opportunity value - largest annual won | number | | `max_annualized_active_opportunity_value` | Opportunity value - largest annualized active | number | | `max_annualized_lost_opportunity_value` | Opportunity value - largest annualized lost | number | | `max_annualized_opportunity_value` | Opportunity value - largest annualized | number | | `max_annualized_won_opportunity_value` | Opportunity value - largest annualized won | number | | `max_monthly_active_opportunity_value` | Opportunity value - largest monthly active | number | | `max_monthly_lost_opportunity_value` | Opportunity value - largest monthly lost | number | | `max_monthly_opportunity_value` | Opportunity value - largest monthly | number | | `max_monthly_won_opportunity_value` | Opportunity value - largest monthly won | number | | `max_one_time_active_opportunity_value` | Opportunity value - largest one time active | number | | `max_one_time_lost_opportunity_value` | Opportunity value - largest one time lost | number | | `max_one_time_opportunity_value` | Opportunity value - largest one time | number | | `max_one_time_won_opportunity_value` | Opportunity value - largest one time won | number | | `max_opportunity_annualized_annualized_value` | Maximum opportunity annualized value | number | | `max_opportunity_confidence_confidence` | Maximum opportunity confidence | integer | | `max_timezone_offset` | | integer | | `meetings_duration` | Total meetings duration | integer | | `min_annual_active_opportunity_value` | Opportunity value - smallest annual active | number | | `min_annual_lost_opportunity_value` | Opportunity value - smallest annual lost | number | | `min_annual_opportunity_value` | Opportunity value - smallest annual | number | | `min_annual_won_opportunity_value` | Opportunity value - smallest annual won | number | | `min_annualized_active_opportunity_value` | Opportunity value - smallest annualized active | number | | `min_annualized_lost_opportunity_value` | Opportunity value - smallest annualized lost | number | | `min_annualized_opportunity_value` | Opportunity value - smallest annualized | number | | `min_annualized_won_opportunity_value` | Opportunity value - smallest annualized won | number | | `min_monthly_active_opportunity_value` | Opportunity value - smallest monthly active | number | | `min_monthly_lost_opportunity_value` | Opportunity value - smallest monthly lost | number | | `min_monthly_opportunity_value` | Opportunity value - smallest monthly | number | | `min_monthly_won_opportunity_value` | Opportunity value - smallest monthly won | number | | `min_one_time_active_opportunity_value` | Opportunity value - smallest one time active | number | | `min_one_time_lost_opportunity_value` | Opportunity value - smallest one time lost | number | | `min_one_time_opportunity_value` | Opportunity value - smallest one time | number | | `min_one_time_won_opportunity_value` | Opportunity value - smallest one time won | number | | `min_opportunity_confidence_confidence` | Minimum opportunity confidence | integer | | `min_timezone_offset` | | integer | | `name` | Name | text | | `next_due` | Next task due date | datetime | | `next_task_date` | Next task date | datetime | | `next_task_due_date` | Next task due date | datetime | | `next_task_text` | Next task text | text | | `next_task_user_id` | Next task user | `user` ID | | `next_upcoming_meeting_duration` | Next upcoming meeting - Duration | integer | | `next_upcoming_meeting_ends_at` | Next upcoming meeting ends at | datetime | | `next_upcoming_meeting_is_recurring` | Next upcoming meeting - Is recurring | boolean | | `next_upcoming_meeting_location` | Next upcoming meeting - Location | text | | `next_upcoming_meeting_note` | Next upcoming meeting - Event notes | text | | `next_upcoming_meeting_num_participants` | Next upcoming meeting - Number of participants | integer | | `next_upcoming_meeting_source` | Next upcoming meeting - Source | one of `calendar`, `manual` | | `next_upcoming_meeting_starts_at` | Next upcoming meeting | datetime | | `next_upcoming_meeting_status` | Next upcoming meeting - Status | one of `upcoming`, `in-progress`, `completed`, `canceled`, `declined-by-org`, `declined-by-lead` | | `next_upcoming_meeting_title` | Next upcoming meeting - Title | text | | `next_upcoming_meeting_users` | Next upcoming meeting - User | `user` ID | | `num_active_opportunities` | Number of active opportunities | integer | | `num_activities` | Total number of activities | integer | | `num_annual_opportunities` | Opportunities - Annual | integer | | `num_calls` | Total number of calls | integer | | `num_canceled_meetings` | Number of canceled meetings | integer | | `num_completed_meetings` | Number of completed meetings | integer | | `num_completed_tasks` | Number of completed tasks | integer | | `num_contact_urls` | # Contact URLs | integer | | `num_contacts` | Total number of contacts | integer | | `num_declined_by_lead_meetings` | Meetings - Declined By Lead | integer | | `num_declined_by_org_meetings` | Meetings - Declined By Org | integer | | `num_declined_meetings` | Number of declined meetings | integer | | `num_draft_emails` | Number of draft emails | integer | | `num_draft_sms` | Number of draft SMS | integer | | `num_email_addresses` | Total number of email addresses | integer | | `num_email_attachments` | # Email attachments | integer | | `num_email_opens` | Total number of email opens | integer | | `num_emails` | Total number of emails | integer | | `num_error_emails` | Number of emails that errored | integer | | `num_error_sms` | Number of SMS that errored | integer | | `num_in_progress_meetings` | Number of in-progress meetings | integer | | `num_incoming_calls` | Number of incoming calls | integer | | `num_incomplete_tasks` | Number of incomplete tasks | integer | | `num_lost_opportunities` | Number of lost opportunities | integer | | `num_meetings` | Total number of meetings | integer | | `num_missed_calls` | Number of missed calls | integer | | `num_monthly_opportunities` | Opportunities - Monthly | integer | | `num_notes` | Total number of notes | integer | | `num_one_time_opportunities` | Opportunities - One-Time | integer | | `num_opportunities` | Total number of opportunities | integer | | `num_outbox_emails` | Number of emails in outbox | integer | | `num_outbox_sms` | Number of SMS in outbox | integer | | `num_outgoing_calls` | Number of outgoing calls | integer | | `num_outgoing_emails` | # Outgoing emails | integer | | `num_phone_numbers` | Total number of phone numbers | integer | | `num_received_emails` | Number of received emails | integer | | `num_received_sms` | Number of received SMS | integer | | `num_scheduled_emails` | Number of scheduled emails | integer | | `num_scheduled_sms` | Number of scheduled SMS | integer | | `num_sent_emails` | Number of sent emails | integer | | `num_sent_sms` | Number of sent SMS | integer | | `num_sms` | Total number of SMS | integer | | `num_tasks` | Total number of tasks | integer | | `num_upcoming_meetings` | Number of upcoming meetings | integer | | `num_won_opportunities` | Number of won opportunities | integer | | `original_lead_status` | Initial lead status | `status.lead` ID | | `outbound_sms_count` | Outbound SMS count | integer | | `pipeline_id` | Current status | `pipeline` ID | | `primary_contact_name` | Primary contact name | text | | `primary_email` | Primary email | email address | | `primary_opportunity_confidence` | Primary opportunity confidence | integer | | `primary_opportunity_created` | Primary opportunity created | datetime | | `primary_opportunity_date_won` | Primary opportunity date won | date | | `primary_opportunity_period` | Primary opportunity period | one of `one_time`, `monthly`, `annual` | | `primary_opportunity_status` | Primary opportunity status | `status.opportunity` ID | | `primary_opportunity_status_type` | Primary opportunity status type | one of `won`, `lost`, `active` | | `primary_opportunity_updated` | Primary opportunity updated | datetime | | `primary_opportunity_user_id` | Primary opportunity assigned to | `user` ID | | `primary_opportunity_value` | Primary opportunity value | number | | `shortest_call_duration` | Longest call duration | integer | | `shortest_voicemail_duration` | Shortest voicemail duration | integer | | `status_id` | Current status | `status.lead` ID | | `time_to_first_call` | Time to first call | integer | | `time_to_first_communication` | Time to first communication | integer | | `time_to_first_email` | Time to first email | integer | | `time_to_first_incoming_call` | Time to first incoming call | integer | | `time_to_first_incoming_communication` | Time to first incoming communication | integer | | `time_to_first_incoming_email` | Time to first incoming email | integer | | `time_to_first_incoming_sms` | Time to first incoming SMS | integer | | `time_to_first_meeting` | Time to first meeting | integer | | `time_to_first_outgoing_call` | Time to first outgoing call | integer | | `time_to_first_outgoing_communication` | Time to first outgoing communication | integer | | `time_to_first_outgoing_email` | Time to first outgoing email | integer | | `time_to_first_outgoing_sms` | Time to first outgoing SMS | integer | | `time_to_first_sms` | Time to first SMS | integer | | `times_communicated` | Total number of times communicated | integer | | `times_communicated_outgoing` | | integer | | `timezone_offset` | Timezone offset | integer | | `total_annual_active_opportunity_value` | Opportunity value - annual active | number | | `total_annual_lost_opportunity_value` | Opportunity value - annual lost | number | | `total_annual_opportunity_value` | Opportunity value - annual | number | | `total_annual_won_opportunity_value` | Opportunity value - annual won | number | | `total_annualized_active_opportunity_value` | Opportunity value - annualized active | number | | `total_annualized_lost_opportunity_value` | Opportunity value - annualized lost | number | | `total_annualized_opportunity_value` | Opportunity value - annualized | number | | `total_annualized_won_opportunity_value` | Opportunity value - annualized won | number | | `total_call_duration` | Total call duration | integer | | `total_monthly_active_opportunity_value` | Opportunity value - monthly active | number | | `total_monthly_lost_opportunity_value` | Opportunity value - monthly lost | number | | `total_monthly_opportunity_value` | Opportunity value - monthly | number | | `total_monthly_won_opportunity_value` | Opportunity value - monthly won | number | | `total_one_time_active_opportunity_value` | Opportunity value - one time active | number | | `total_one_time_lost_opportunity_value` | Opportunity value - one time lost | number | | `total_one_time_opportunity_value` | Opportunity value - one time | number | | `total_one_time_won_opportunity_value` | Opportunity value - one time won | number | | `upcoming_meetings_duration` | Upcoming meetings duration | integer | | `updated_by` | Last updated by | `user` ID | | `url` | URL | URL | | `urls_count` | Lead URL | integer | ### `contact` | Field | Description | Value type | | ------------------------------ | --------------------------------------- | ---------------------- | | `contact_id` | | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `emails_count` | Number of email addresses | integer | | `is_primary` | First contact | boolean | | `last_step_date_created` | Last Subscription Step Date Created | datetime | | `lead_id` | Lead | `lead` ID | | `max_step_last_processed_at` | Max Subscription Step Last Processed At | datetime | | `max_tz_offset` | | integer | | `min_tz_offset` | | integer | | `name` | Name | text | | `num_call_tasks` | | integer | | `num_completed_call_tasks` | | integer | | `num_incomplete_call_tasks` | | integer | | `phones_count` | Number of phone numbers | integer | | `timezone` | | timezone | | `title` | Title | text | | `updated_by` | Last updated by | `user` ID | | `updated_by_agent_id` | Last updated by agent | `agent_config` ID | | `updated_by_any_agent` | | `any_agent` ID | | `updated_by_user_or_any_agent` | Last updated by | `user_or_any_agent` ID | | `urls_count` | Number of URLs | integer | | `user_id` | | `user` ID | | `users` | | `user` ID | ### `opportunity` | Field | Description | Value type | | ----------------------------- | ------------------------- | -------------------------------------- | | `annualized_expected_value` | Annualized expected value | number | | `annualized_value` | Value, annualized | number | | `confidence` | Confidence | integer | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_lost` | Date lost | datetime | | `date_updated` | Date last updated | datetime | | `date_won` | Close date | date | | `expected_value` | Expected value | number | | `is_stalled` | Needs attention | boolean | | `lead_id` | Lead | `lead` ID | | `note` | Note | text | | `original_opportunity_status` | Initial status | `status.opportunity` ID | | `pipeline_id` | Pipeline | `pipeline` ID | | `status_id` | Current status | `status.opportunity` ID | | `status_type` | Status type | one of `won`, `lost`, `active` | | `updated_by` | Last updated by | `user` ID | | `user_id` | Assigned to | `user` ID | | `users` | | `user` ID | | `value` | Value | number | | `value_currency` | Value currency | fixed value | | `value_period` | Period | one of `one_time`, `monthly`, `annual` | ## Lead & Contact Details ### `address` | Field | Description | Value type | | ----------------- | --------------- | ---------- | | `address_1` | Address line 1 | text | | `address_2` | Address line 2 | text | | `city` | City | text | | `country` | Country | country | | `label` | Label | text | | `location` | Address | text | | `state` | State | state | | `timezone_id` | Local time | timezone | | `timezone_offset` | Timezone offset | integer | | `zipcode` | Zip code | text | ### `contact_email` | Field | Description | Value type | | ----------------- | ------------- | ------------- | | `email` | Email address | email address | | `is_unsubscribed` | Unsubscribed | boolean | ### `contact_phone` | Field | Description | Value type | | ----------------- | --------------- | ------------ | | `is_toll_free` | Toll free | boolean | | `phone` | Phone number | phone number | | `timezone_id` | Local time | timezone | | `timezone_offset` | Timezone offset | integer | ### `contact_url` | Field | Description | Value type | | ----- | ----------- | ---------- | | `url` | URL | URL | ## Activities ### `activity.call` | Field | Description | Value type | | -------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `agent_config_id` | Agent Config | `agent_config` ID | | `any_agent` | | `any_agent` ID | | `call_agent_grade_funnel_stage` | Funnel Stage | one of `no_connection`, `human_reached`, `prospect_engaged`, `objective_met` | | `call_agent_grade_performance_summary` | | text | | `call_agent_grade_sentiment_score` | Sentiment Score | integer | | `call_method` | Method | fixed value | | `called_by` | Called by | `user` ID | | `called_to` | Called | `user` ID | | `comm_type` | Communication type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `contact_id` | Contact | `contact` ID | | `conversation_type_id` | Playbook | `conversation_type` ID | | `conversation_type_reason` | Playbook set by | one of `user-selected`, `autodetected` | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date` | Date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `dialer_id` | Dialer ID | `dialer` ID | | `dialer_saved_search_id` | Dialed from Smart View | `saved_search` ID | | `direction` | Direction | one of `inbound`, `outbound` | | `disposition` | Disposition | one of `no-answer`, `answered`, `vm-answer`, `vm-left`, `busy`, `blocked`, `error`, `abandoned` | | `duration` | Duration | integer | | `has_any_tool_error` | Has any tool error | boolean | | `has_note` | Has a note | boolean | | `has_recording` | Was recorded | boolean | | `has_voicemail` | Is a voicemail | boolean | | `incoming_call_date` | Incoming call date | datetime | | `is_actual` | Not sent or received | boolean | | `is_missed` | Missed | boolean | | `is_to_group_number` | Group number was called | boolean | | `lead_id` | Lead | `lead` ID | | `local_phone` | Local phone | phone number | | `mentions` | Mentions in the note | `user_or_group` ID | | `note` | Note | text | | `outcome_id` | Outcome | `outcome` ID | | `outgoing_call_date` | Outgoing call date | datetime | | `phone` | Phone number | phone number | | `playbook_id` | Playbook | `conversation_type` ID | | `playbook_reason` | Playbook set by | one of `user-selected`, `autodetected` | | `recording_duration` | Recording | integer | | `recording_expires_at` | Recording Expires At | datetime | | `recording_summary` | Recording Summary | text | | `recording_transcript` | Recording Transcript | text | | `remote_phone` | Remote phone | phone number | | `sequence_id` | Workflow used | `sequence` ID | | `sequence_subscription_id` | Called with a sequence subscription | `sequence_subscription` ID | | `skill_use_names` | Skill used | one of `schedule_callback`, `create_task`, `send_scheduling_link`, `book_meeting`, `send_handoff_alert`, `search_knowledge_base`, `transfer_call`, `press_keypad` | | `source` | Source | one of `close.io`, `external` | | `status` | Status | one of `created`, `in-progress`, `completed`, `cancel`, `no-answer`, `busy`, `failed`, `timeout` | | `talk_time` | Total Recording Talk Time | integer | | `transferred` | Transferred | boolean | | `transferred_from` | Transferred from | `activity.call` ID | | `transferred_from_user` | Transferred from | `user` ID | | `transferred_to` | Transferred to | `activity.call` ID | | `transferred_to_user` | Transferred to | `user` ID | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `user_talk_time` | Total User Talk Time | integer | | `user_talk_time_ratio` | User Talk Time Percent | number | | `users` | User | `user` ID | | `voicemail_duration` | Voicemail duration | integer | | `voicemail_transcript` | Voicemail Transcript | text | ### `activity.created` | Field | Description | Value type | | -------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `import_id` | Created by Import | `import` ID | | `lead_id` | Lead | `lead` ID | | `source` | Source | one of `ui`, `api`, `import`, `clipper`, `email`, `suggestion`, `segment-integration`, `customerio-integration`, `calendly-integration`, `ai`, `whatsapp`, `webform` | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ### `activity.custom_activity` | Field | Description | Value type | | ------------------------------ | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `custom_activity_type_id` | Custom Activity Type | `custom_activity_type` ID | | `custom_activity_type_version` | | integer | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `mentions` | Mentions within any rich text fields | `user_or_group` ID | | `pinned_at` | Pinned at | datetime | | `source` | Source | one of `ui`, `api`, `import`, `clipper`, `email`, `suggestion`, `segment-integration`, `customerio-integration`, `calendly-integration`, `ai`, `whatsapp`, `webform` | | `status` | Status | one of `draft`, `published` | | `updated_by` | Last updated by | `user` ID | | `updated_by_agent_id` | Last updated by agent | `agent_config` ID | | `updated_by_any_agent` | | `any_agent` ID | | `updated_by_user_or_any_agent` | Last updated by | `user_or_any_agent` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.email` | Field | Description | Value type | | ------------------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `agent_action_reason` | | one of `send_scheduling_link`, `custom_agent_decision`, `voice_agent_callback` | | `agent_config_id` | Agent Config | `agent_config` ID | | `all_bcc` | BCC | text | | `all_cc` | CC | text | | `all_to` | To | text | | `any_agent` | | `any_agent` ID | | `attachment_count` | Number of attachments | integer | | `attachment_name` | Email attachment name | text | | `bcc` | BCC | text | | `body_text` | Body | text | | `bulk_email_action_id` | Bulk Email | `bulk_action.email` ID | | `cc` | CC | text | | `comm_type` | Communication type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date` | Date | datetime | | `date_created` | Date created | datetime | | `date_emailed` | Emailed date | datetime | | `date_received` | Date received | datetime | | `date_scheduled` | Scheduled at | datetime | | `date_sent` | Date sent | datetime | | `date_updated` | Date last updated | datetime | | `direction` | Direction | one of `incoming`, `outgoing` | | `emailed_by` | Emailed by | text | | `emailed_template_id` | Email Template used | `email_template` ID | | `envelope/is_autoreply` | | boolean | | `first_date_open` | First open date | datetime | | `has_reply` | Has reply | boolean | | `has_template` | Sent with a template | boolean | | `in_reply_to_id` | In reply to | `activity.email` ID | | `is_actual` | Not sent or received | boolean | | `is_bulk_email` | Sent by bulk email | boolean | | `last_date_open` | Last open date | datetime | | `lead_id` | Lead | `lead` ID | | `open_dates` | Date opened | datetime | | `opens_count` | Number of opens | integer | | `recipient` | Recipient name or email address | text | | `send_as_id` | | `user` ID | | `sender` | Sender name or email address | text | | `sent` | Sent date | datetime | | `sequence_id` | Workflow used | `sequence` ID | | `sequence_subscription_id` | Sent with a sequence subscription | `sequence_subscription` ID | | `status` | Current state of the email | one of `inbox`, `draft`, `scheduled`, `outbox`, `sent`, `error` | | `subject` | Subject | text | | `template_id` | Email Template used | `email_template` ID | | `thread_id` | Thread | `activity.email_thread` ID | | `to` | To | text | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.email_thread` | Field | Description | Value type | | --------------------------- | ----------------------- | ------------------- | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `email_ids` | Emails | `activity.email` ID | | `importance_reason` | Importance Reason | fixed value | | `is_important` | Is Important | boolean | | `latest_normalized_subject` | Last normalized subject | text | | `lead_id` | Lead | `lead` ID | | `n_emails` | Number of emails | integer | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ### `activity.form_submission` | Field | Description | Value type | | ----------------------- | ----------------- | ----------------------- | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `form_configuration_id` | | `form_configuration` ID | | `form_id` | Web Form | `form` ID | | `lead_id` | Lead | `lead` ID | | `source_url` | | URL | | `source_url_normalized` | Submission URL | URL | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | ### `activity.import_update` | Field | Description | Value type | | -------------- | ------------------- | ------------ | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `import_id` | Updated by Import | `import` ID | | `lead_id` | Lead | `lead` ID | | `reverted` | Update was Reverted | boolean | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ### `activity.lead_merge` | Field | Description | Value type | | --------------------- | ------------------- | ------------ | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `destination_lead_id` | Destination Lead ID | `lead` ID | | `lead_id` | Lead | `lead` ID | | `merge_status` | Merge Status | fixed value | | `source_lead_id` | Source Lead ID | `lead` ID | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ### `activity.lead_status_change` | Field | Description | Value type | | ---------------------- | ----------------- | ---------------------- | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `new_pipeline_id` | New status | `pipeline` ID | | `new_status_id` | New status | `status.lead` ID | | `old_pipeline_id` | Old status | `pipeline` ID | | `old_status_id` | Old status | `status.lead` ID | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.meeting` | Field | Description | Value type | | ------------------------------ | ---------------------------- | ------------------------------------------------------------------------------------------------ | | `activity_at` | At | datetime | | `agent_config_id` | Agent Config | `agent_config` ID | | `any_agent` | | `any_agent` ID | | `connected_account_id` | Account | `connected_account` ID | | `contact_id` | Contact | `contact` ID | | `conversation_type_id` | Playbook | `conversation_type` ID | | `conversation_type_reason` | Playbook set by | one of `user-selected`, `autodetected` | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `duration` | Duration | integer | | `ends_at` | Ends At | datetime | | `has_recording` | Was recorded | boolean | | `has_zoom_recordings` | Has Zoom recordings | boolean | | `is_actual` | | boolean | | `is_declined` | Declined | boolean | | `is_recurring` | Is Recurring | boolean | | `lead_id` | Lead | `lead` ID | | `location` | Location | text | | `mentions` | Mentions in the User's notes | `user_or_group` ID | | `note` | Event notes | text | | `outcome_id` | Outcome | `outcome` ID | | `participant_count` | Number of participants | integer | | `playbook_id` | Playbook | `conversation_type` ID | | `playbook_reason` | Playbook set by | one of `user-selected`, `autodetected` | | `recording_transcript` | Recording Transcript | text | | `source` | Source | one of `calendar`, `manual` | | `starts_at` | Date | datetime | | `status` | Status | one of `upcoming`, `in-progress`, `completed`, `canceled`, `declined-by-org`, `declined-by-lead` | | `talk_time` | Total Recording Talk Time | integer | | `title` | Title | text | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_note` | User notes | text | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `user_talk_time` | Total User Talk Time | integer | | `user_talk_time_ratio` | User Talk Time Percent | number | | `users` | User | `user` ID | ### `activity.note` | Field | Description | Value type | | ------------------------------ | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `agent_action_reason` | | one of `send_scheduling_link`, `custom_agent_decision`, `voice_agent_callback` | | `agent_config_id` | Agent Config | `agent_config` ID | | `any_agent` | | `any_agent` ID | | `attachment_count` | Number of attachments | integer | | `attachment_name` | Note attachment name | text | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `mentions` | Mentions within note body | `user_or_group` ID | | `note` | Text | text | | `pinned_at` | Pinned at | datetime | | `source` | Source | one of `ui`, `api`, `import`, `clipper`, `email`, `suggestion`, `segment-integration`, `customerio-integration`, `calendly-integration`, `ai`, `whatsapp`, `webform` | | `title` | Title | text | | `updated_by` | Last updated by | `user` ID | | `updated_by_agent_id` | Last updated by agent | `agent_config` ID | | `updated_by_any_agent` | | `any_agent` ID | | `updated_by_user_or_any_agent` | Last updated by | `user_or_any_agent` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.opportunity_status_change` | Field | Description | Value type | | ---------------------- | ----------------- | ------------------------------ | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `new_pipeline_id` | New pipeline | `pipeline` ID | | `new_status_id` | New status | `status.opportunity` ID | | `new_status_type` | New status type | one of `won`, `lost`, `active` | | `old_pipeline_id` | Old pipeline | `pipeline` ID | | `old_status_id` | Old status | `status.opportunity` ID | | `old_status_type` | Old status type | one of `won`, `lost`, `active` | | `opportunity_id` | Opportunity | `opportunity` ID | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.sms` | Field | Description | Value type | | ------------------------------ | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `agent_action_reason` | | one of `send_scheduling_link`, `custom_agent_decision`, `voice_agent_callback` | | `agent_config_id` | Agent Config | `agent_config` ID | | `any_agent` | | `any_agent` ID | | `attachment_count` | Number of attachments | integer | | `attachment_name` | SMS attachment name | text | | `comm_type` | Communication type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date` | Date | datetime | | `date_created` | Date created | datetime | | `date_scheduled` | Date scheduled | datetime | | `date_sent` | Date sent | datetime | | `date_updated` | Date last updated | datetime | | `direction` | Direction | one of `inbound`, `outbound` | | `from_phone` | Phone | phone number | | `inbound_date` | Incoming SMS date | datetime | | `is_actual` | Not sent or received | boolean | | `lead_id` | Lead | `lead` ID | | `local_phone` | Local phone | phone number | | `outbound_date` | Outgoing SMS date | datetime | | `remote_phone` | Remote phone | phone number | | `sender` | Sender | `user` ID | | `sent` | Sent date | datetime | | `source` | Source | one of `Close.io`, `External` | | `status` | Status | one of `inbox`, `draft`, `scheduled`, `outbox`, `sent`, `error` | | `template_id` | SMS Template used | `sms_template` ID | | `text` | Message | text | | `to_phone` | Phone | phone number | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | User or Agent | `user_or_any_agent` ID | | `users` | User | `user` ID | ### `activity.task_completed` | Field | Description | Value type | | ------------------ | ----------------- | ------------ | | `activity_at` | At | datetime | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `task_assigned_to` | Assigned to | `user` ID | | `task_text` | Description | text | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ### `activity.whatsapp_message` | Field | Description | Value type | | ------------------ | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activity_at` | At | datetime | | `attachment_count` | Number of attachments | integer | | `attachment_name` | WhatsApp attachment name | text | | `comm_type` | Communication type | one of `call`, `outgoing_call`, `incoming_answered_call`, `missed_call`, `received_voicemail`, `received_email`, `sent_email`, `received_sms`, `sent_sms`, `received_whatsapp_message`, `sent_whatsapp_message` | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `direction` | Direction | one of `incoming`, `outgoing` | | `from_phone` | Phone | phone number | | `inbound_date` | Incoming WhatsApp message date | datetime | | `lead_id` | Lead | `lead` ID | | `local_phone` | Local phone | phone number | | `outbound_date` | Outgoing WhatsApp message date | datetime | | `remote_phone` | Remote phone | phone number | | `sender` | Sender | `user` ID | | `source` | Source | one of `ui`, `api`, `import`, `clipper`, `email`, `suggestion`, `segment-integration`, `customerio-integration`, `calendly-integration`, `ai`, `whatsapp`, `webform` | | `text` | Message | text | | `to_phone` | Phone | phone number | | `updated_by` | Last updated by | `user` ID | | `user_id` | User | `user` ID | | `users` | User | `user` ID | ## Tasks ### `task.answered_detached_call` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.draft_email` | Field | Description | Value type | | ---------------------------------- | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `sequence_id` | Workflow | `sequence` ID | | `sequence_subscription_history_id` | Workflow Run History | `subscription_history` ID | | `sequence_subscription_id` | Workflow Run | `sequence_subscription` ID | | `step_id` | Workflow Step | `sequence_step` ID | | `updated_by` | Last updated by | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.draft_sms` | Field | Description | Value type | | ---------------------------------- | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `sequence_id` | Workflow | `sequence` ID | | `sequence_subscription_history_id` | Workflow Run History | `subscription_history` ID | | `sequence_subscription_id` | Workflow Run | `sequence_subscription` ID | | `step_id` | Workflow Step | `sequence_step` ID | | `updated_by` | Last updated by | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.email_followup` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `email_id` | Email | `activity.email` ID | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.incoming_email` | Field | Description | Value type | | ------------------------------ | --------------------------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `emails` | Email | `activity.email` ID | | `is_answered` | | boolean | | `is_autoreply` | email is an autoreply | boolean | | `is_bounce` | email is a bounce notification | boolean | | `is_cc_or_bcc` | | boolean | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `is_scheduling_email` | email is likely coordinating event scheduling | boolean | | `is_transactional` | email is likely transactional | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.incoming_sms` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_answered` | | boolean | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_opt_out` | | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `local_phone` | Local phone | phone number | | `object_type` | Type of referenced object | fixed value | | `remote_phone` | Remote phone | phone number | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.incoming_whatsapp_message` | Field | Description | Value type | | ------------------------------ | ----------- | ----------------------------------- | | `assigned_to` | | `user` ID | | `contact_id` | | `contact` ID | | `created_by` | | `user` ID | | `date` | | datetime | | `date_created` | | datetime | | `date_updated` | | datetime | | `is_complete` | | boolean | | `is_new` | | boolean | | `is_primary_lead_notification` | | boolean | | `lead_id` | | `lead` ID | | `local_phone` | | phone number | | `object_type` | | fixed value | | `remote_phone` | | phone number | | `updated_by` | | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | | one of `inbox`, `future`, `archive` | ### `task.lead` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `due_date` | Date due | datetime | | `is_complete` | Complete | boolean | | `is_dateless` | Has a date | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `priority` | Priority | one of `high`, `medium` | | `text` | Task description | text | | `updated_by` | Last updated by | `user` ID | | `updated_by_agent_id` | Last updated by agent | `agent_config` ID | | `updated_by_any_agent` | | `any_agent` ID | | `updated_by_user_or_any_agent` | Last updated by | `user_or_any_agent` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.lead_suggestion_incoming_email` | Field | Description | Value type | | ------------------------------ | ----------- | ----------------------------------- | | `assigned_to` | | `user` ID | | `created_by` | | `user` ID | | `date` | | datetime | | `date_created` | | datetime | | `date_updated` | | datetime | | `is_complete` | | boolean | | `is_new` | | boolean | | `is_primary_lead_notification` | | boolean | | `lead_id` | | `lead` ID | | `object_type` | | fixed value | | `updated_by` | | `user` ID | | `user_id` | | `user` ID | | `view` | | one of `inbox`, `future`, `archive` | ### `task.missed_call` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `local_phone` | Local phone | phone number | | `object_type` | Type of referenced object | fixed value | | `phone` | Phone | phone number | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.opportunities_awaiting_action` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `opportunity_id` | Opportunity | `opportunity` ID | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.opportunity_due` | Field | Description | Value type | | ------------------------------ | ------------------------- | -------------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_datetime` | | boolean | | `is_deleted` | | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `membership` | | `membership` ID | | `object_type` | Type of referenced object | fixed value | | `opportunity_note` | | text | | `opportunity_value` | | integer | | `opportunity_value_period` | | one of `one_time`, `monthly`, `annual` | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.outbound_call` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `agent_config_id` | Agent Config | `agent_config` ID | | `any_agent` | | `any_agent` ID | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `created_by_agent_id` | Created by agent | `agent_config` ID | | `created_by_any_agent` | | `any_agent` ID | | `created_by_user_or_any_agent` | Created by | `user_or_any_agent` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `priority` | Priority | one of `high`, `medium` | | `sequence_id` | Workflow | `sequence` ID | | `step_id` | Workflow Step | `sequence_step` ID | | `text` | Task description | text | | `updated_by` | Last updated by | `user` ID | | `user_or_agent` | User or Agent | `user_or_any_agent` ID | | `user_or_any_agent` | Assigned User or Agent | `user_or_any_agent` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ### `task.voicemail` | Field | Description | Value type | | ------------------------------ | ------------------------- | ----------------------------------- | | `assigned_to` | Assigned to | `user` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date` | Due date | datetime | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_complete` | Complete | boolean | | `is_new` | Not archived | boolean | | `is_primary_lead_notification` | For the primary lead | boolean | | `lead_id` | Lead | `lead` ID | | `object_type` | Type of referenced object | fixed value | | `updated_by` | Last updated by | `user` ID | | `user_id` | | `user` ID | | `users` | | `user` ID | | `view` | Inbox view | one of `inbox`, `future`, `archive` | ## Other Objects ### `agent_call_grade` | Field | Description | Value type | | --------------------------------- | ------------------- | ---------------------------------------------------------------------------- | | `agent_grade_funnel_stage` | Funnel Stage | one of `no_connection`, `human_reached`, `prospect_engaged`, `objective_met` | | `agent_grade_performance_summary` | Performance Summary | text | | `agent_grade_sentiment_score` | Sentiment Score | integer | | `call_id` | Call | `activity.call` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `updated_by` | Last updated by | `user` ID | ### `comment` | Field | Description | Value type | | -------------- | ------------------------------------ | ------------------ | | `body_text` | Body | text | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `mentions` | Mentions within any rich text fields | `user_or_group` ID | | `updated_by` | Last updated by | `user` ID | ### `comment_thread` | Field | Description | Value type | | --------------- | ------------------ | ----------- | | `comment_count` | Number of comments | integer | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `object_type` | Object Type | fixed value | | `updated_by` | Last updated by | `user` ID | | `users` | | `user` ID | ### `custom_fields.contact` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | ### `custom_fields.lead` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | ### `custom_fields.opportunity` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | ### `custom_object` | Field | Description | Value type | | ----------------------- | ------------------ | ----------------------- | | `created_by` | Created by | `user` ID | | `custom_object_type_id` | Custom Object Type | `custom_object_type` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | ### `email_template` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_archived` | Archived | boolean | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | ### `lead_file` | Field | Description | Value type | | ------------------ | ----------------- | ------------ | | `content_type` | Content Type | content type | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_pinned` | Is Pinned | boolean | | `last_activity_at` | Last Activity At | datetime | | `lead_id` | Lead | `lead` ID | | `name` | Name | text | | `size` | Size | integer | | `updated_by` | Last updated by | `user` ID | ### `lead_summary` | Field | Description | Value type | | -------------- | ----------------- | ----------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `lead_id` | Lead | `lead` ID | | `status` | Status | fixed value | | `summary_type` | Summary Type | fixed value | | `text` | | text | | `updated_by` | Last updated by | `user` ID | ### `saved_search` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_shared` | Shared | boolean | | `name` | Name | text | | `updated_by` | Last updated by | `user` ID | | `user_id` | Owner | `user` ID | ### `sequence_subscription` | Field | Description | Value type | | ------------------------ | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `calls_assigned_to` | Calls assigned to | `user_or_group` ID | | `contact_id` | Contact | `contact` ID | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_paused` | Date paused | datetime | | `date_updated` | Date last updated | datetime | | `initial_email_id` | Initial email | `activity.email` ID | | `last_completed_step` | Last completed step | `sequence_step` ID | | `last_processed_step` | Last processed step | `sequence_step` ID | | `lead_id` | Lead | `lead` ID | | `owner_id` | Owner | `user` ID | | `run_once` | Run once | boolean | | `sender_account_id` | Sender account | `connected_account` ID | | `sequence_id` | Workflow | `sequence` ID | | `start_date` | Start date | datetime | | `status` | Status | one of `active`, `paused`, `finished`, `goal`, `error` | | `status_reason` | Status reason | one of `manual`, `pending-call-timed-out`, `bulk-action`, `rate-limited`, `sequence-deleted`, `workflow-paused`, `filter-not-matched`, `insufficient-ai-credit-balance`, `plan-not-supported`, `reply-received`, `call-answered`, `meeting-booked`, `lead-status-changed`, `outcome-met`, `account-invalid`, `account-failures`, `sending-throttled-too-long`, `membership-inactive`, `send-as-error`, `email-bounced`, `call-failed`, `sms-failed`, `no-user-phone`, `billing-error`, `assignment-field-invalid`, `lead-status-field-invalid`, `assignees-missing`, `run-as-disabled`, `lead-not-visible`, `internal-error`, `field-mapping-error`, `filter-config-invalid`, `email-ai-generation-failed` | | `step_last_processed_at` | Last processed step date | datetime | | `steps_completed` | Number of completed subscription steps | integer | | `time_to_goal` | Time to goal | integer | | `updated_by` | Last updated by | `user` ID | ### `sms_template` | Field | Description | Value type | | -------------- | ----------------- | ----------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `is_shared` | Is Shared | boolean | | `name` | Name | text | | `owned_by` | Owned by | `user` ID | | `status` | Status | fixed value | | `updated_by` | Last updated by | `user` ID | ### `status.lead` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `label` | Status label | text | | `updated_by` | Last updated by | `user` ID | ### `status.opportunity` | Field | Description | Value type | | -------------- | ----------------- | ---------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_updated` | Date last updated | datetime | | `label` | Status label | text | | `updated_by` | Last updated by | `user` ID | ### `subscription_history` | Field | Description | Value type | | -------------------------- | ----------------- | -------------------------- | | `created_by` | Created by | `user` ID | | `date_created` | Date created | datetime | | `date_sent` | | datetime | | `date_updated` | Date last updated | datetime | | `email_id` | Email | `activity.email` ID | | `lead_id` | Lead | `lead` ID | | `sequence_subscription_id` | Subscription | `sequence_subscription` ID | | `status` | History Status | fixed value | | `step_id` | Workflow Step | `sequence_step` ID | | `step_type` | Step Type | fixed value | | `subject` | | text | | `template_id` | | `email_template` ID | | `updated_by` | Last updated by | `user` ID |