Users, email accounts, lists and labels, notes, usage stats and webhook results. 12 operation(s) from the published Apollo OpenAPI.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/apollo-io-miscellaneous-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Apollo.io Miscellaneous API
version: '1.0'
summary: Programmatic access to Apollo's sales intelligence and engagement platform — data enrichment, prospect and company search, and go-to-market workflow management.
description: 'The Apollo API provides programmatic access to [Apollo](https://www.apollo.io/), the all-in-one sales intelligence and engagement platform. Use it to enrich people and company data (individually or in bulk), search Apollo''s database of over 240 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.
## Base URL
All API requests are made to `https://api.apollo.io/api/v1`.
## Authentication
- **Apollo users** authenticate with an API key passed in the `x-api-key` request header. See [Create API Keys](https://docs.apollo.io/docs/create-api-key).
- **Apollo partners** building integrations on behalf of mutual users authenticate with the [OAuth 2.0 authorization flow](https://docs.apollo.io/docs/use-oauth-20-authorization-flow-to-access-apollo-user-information-partners).
## Rate limits & credits
Rate limits and credit consumption depend on your [Apollo pricing plan](https://docs.apollo.io/docs/api-pricing). Check your current limits and usage with the [View API Usage Stats and Rate Limits](https://docs.apollo.io/reference/view-api-usage-stats) endpoint. For more details, see [Rate Limits](https://docs.apollo.io/reference/rate-limits) and the [API FAQs](https://docs.apollo.io/docs/apollo-api-faqs).
New to the API? Start with the [Apollo API overview](https://docs.apollo.io/reference/apollo-api).'
termsOfService: https://www.apollo.io/terms/api
contact:
name: Apollo API Support
url: https://docs.apollo.io/
servers:
- url: https://api.apollo.io/api/v1
security:
- apiKey: []
- bearerAuth: []
tags:
- name: Miscellaneous
description: Users, email accounts, lists, notes, usage stats, and webhook results.
paths:
/users/search:
get:
summary: Get a List of Users
description: '## Endpoint essentials
**API key access:** `api/v1/users/search` or `Master API key`
**OAuth scopes:** `users_list`
**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).
<a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.<br><br>These IDs can be used for several other endpoints, including the <a href="https://docs.apollo.io/reference/create-deal">Create a Deal</a>, <a href="https://docs.apollo.io/reference/create-an-account">Create an Account</a>, and <a href="https://docs.apollo.io/reference/create-a-task">Create a Task</a> endpoints.'
tags:
- Miscellaneous
operationId: get-a-list-of-users
parameters:
- name: page
in: query
description: 'The page number of the Apollo data that you want to retrieve. <br><br>Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint. <br><br>Example: `4`'
schema:
type: integer
format: int32
- name: per_page
in: query
description: 'The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint''s performance. <br><br>Use the `page` parameter to search the different pages of data. <br><br>Example: `10`'
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"pagination\": {\n \"page\": \"1\",\n \"per_page\": \"3\",\n \"total_entries\": 23,\n \"total_pages\": 8\n },\n \"users\": [\n {\n \"id\": \"66c8db577ed7f201b25c0eef\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"first_name\": null,\n \"last_name\": null,\n \"title\": null,\n \"email\": \"anita.rao@apollomail.io\",\n \"created_at\": \"2024-08-23T18:56:24.067Z\",\n \"credit_limit\": null,\n \"direct_dial_credit_limit\": null,\n \"export_credit_limit\": null,\n \"ai_credit_limit\": null,\n \"salesforce_account\": null,\n \"deleted\": false,\n \"opt_out_html_template\": \"No longer interested in these messages? <%Unsubscribe%>\",\n \"name\": \"\",\n \"referral_code\": \"nzu90RCUSGkFzsavf4Efh3\",\n \"password_needs_reset\": false,\n \"salesforce_id\": null,\n \"default_cockpit_layout\": null,\n \"default_account_overview_layout_id\": null,\n \"default_contact_overview_layout_id\": null,\n \"default_person_overview_layout_id\": null,\n \"default_organization_overview_layout_id\": null,\n \"default_opportunity_overview_layout_id\": null,\n \"default_home_overview_layout_id\": null,\n \"bridge_calls\": false,\n \"bridge_phone_number\": null,\n \"bridge_incoming_calls\": false,\n \"bridge_incoming_phone_number\": null,\n \"current_email_verified\": true,\n \"record_calls\": true,\n \"salesforce_instance_url\": null,\n \"permission_set_id\": \"6170904d46a82c00c227b744\",\n \"default_use_local_numbers\": false,\n \"disable_email_linking\": null,\n \"sync_salesforce_id\": null,\n \"sync_crm_id\": null,\n \"zp_contact_id\": \"66ca3f1309358c0001ea7e4d\",\n \"chrome_extension_downloaded\": false,\n \"zp_is_super_analytics_user\": null,\n \"email_oauth_signin_only\": false,\n \"notification_last_created_at\": null,\n \"crm_requested_to_integrate\": null,\n \"has_invited_user\": false,\n \"has_used_enrichment\": false,\n \"has_uploaded_csv\": false,\n \"has_hidden_onboarding\": false,\n \"notification_last_read_at\": null,\n \"daily_data_request_email\": false,\n \"data_request_emails\": true,\n \"daily_task_email\": true,\n \"free_data_credits_email\": true,\n \"dismiss_new_team_suggestion\": true,\n \"request_email_change_to\": null,\n \"self_identified_persona\": null,\n \"territory_is_active\": true,\n \"conversation_is_private\": null,\n \"show_deals_detail_page_updates_modal\": true,\n \"assistant_setting\": {\n \"_id\": \"66c8db587ed7f201b25c0ef0\",\n \"deal_size_metric\": \"amount\",\n \"inactive_account_stage_ids\": [],\n \"inactive_contact_stage_ids\": [],\n \"insight_deal_size_signals\": {},\n \"insight_sale_cycle_signals\": {},\n \"insight_win_rate_signals\": {},\n \"is_persona_recommendation_requested\": false,\n \"job_posting_locations\": [],\n \"job_posting_titles\": [],\n \"latest_funding_days\": 90,\n \"max_num_active_accounts\": 100,\n \"max_people_in_sequence_per_account\": 5,\n \"num_inactive_days_to_re_engage\": 180,\n \"persona_ids\": [\n \"65d829661453d30300a0c9e3\",\n \"65e76d7f00d9c601aed49f6c\",\n \"65e8bf1f1132a70579a84d61\",\n \"65eb62d262c9dc01c66b2675\",\n \"66200c046194fa01c707b520\",\n \"662057f7d9db7a01c7ba9960\"\n ],\n \"should_show_persona_banner\": true,\n \"success_case_account_stage_ids\": [],\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"technology_uids\": [],\n \"territory_company_size_ranges\": [],\n \"territory_location_override\": false,\n \"territory_locations\": [\n \"United States\"\n ],\n \"territory_person_locations\": [\n \"United States\"\n ],\n \"user_id\": \"66c8db577ed7f201b25c0eef\",\n \"id\": \"66c8db587ed7f201b25c0ef0\",\n \"key\": \"66c8db587ed7f201b25c0ef0\"\n },\n \"fields_fully_loaded\": true,\n \"typed_custom_fields\": null,\n \"connected_to_slack\": false,\n \"crm_email\": null,\n \"triggered_referral_campaigns\": [],\n \"enable_click_tracking\": false,\n \"enable_open_tracking\": true,\n \"should_include_unsubscribe_link\": false,\n \"enable_one_click_unsubscribe\": null,\n \"subteam_ids\": [],\n \"prospect_territory_ids\": [],\n \"toggled_on_territory_ids\": [],\n \"linked_salesforce\": null,\n \"linked_zoom_conference_account\": false,\n \"linked_bot_conference_account\": true,\n \"linked_bot_conference_account_platforms\": [\n \"google_meet\",\n \"ms_teams\"\n ],\n \"has_conference_account\": true,\n \"linked_hubspot\": false,\n \"linked_salesloft\": false,\n \"linked_crm_name\": null,\n \"chrome_extension_enabled_features\": [\n \"apollo_everywhere\",\n \"gmail\",\n \"linkedin\",\n \"salesforce\",\n \"hubspot\",\n \"google_calendar\"\n ],\n \"chrome_extension_exclude_from_websites\": [\n \"facebook.com\",\n \"youtube.com\",\n \"instagram.com\",\n \"google.com\",\n \"live.com\",\n \"yahoo.com\",\n \"notion.so\",\n \"atlassian.net\",\n \"asana.com\",\n \"typeform.com\",\n \"figma.com\"\n ],\n \"chrome_extension_everywhere_icon_horizontal_position\": \"right\",\n \"chrome_extension_everywhere_icon_vertical_position_in_vh\": 10,\n \"default_chrome_extension_log_email_send_to_salesforce\": true,\n \"default_chrome_extension_log_email_send_to_hubspot\": true,\n \"chrome_extension_auto_match_salesforce_opportunity\": true,\n \"chrome_extension_gmail_enable_email_tools\": true,\n \"enable_desktop_notifications\": false,\n \"enable_gmail_desktop_notifications\": null,\n \"default_chrome_extension_enable_reminders\": false,\n \"chrome_extension_gmail_enable_crm_sidebar\": true,\n \"show_chrome_extension_buying_intent_promo\": true,\n \"apollo_everywhere_search_count\": 0\n },\n {\n \"id\": \"66aaac5a0e951f01b37012bd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"first_name\": \"\",\n \"last_name\": null,\n \"title\": \"\",\n \"email\": \"gina.larkin@apollomail.io\",\n \"created_at\": \"2024-07-31T21:27:54.929Z\",\n \"credit_limit\": null,\n \"direct_dial_credit_limit\": null,\n \"export_credit_limit\": null,\n \"ai_credit_limit\": null,\n \"salesforce_account\": null,\n \"deleted\": false,\n \"opt_out_html_template\": \"No longer interested in these messages? <%Unsubscribe%>\",\n \"name\": \"\",\n \"referral_code\": \"vBNOmoTcZPy5Y0QdxJIAR9\",\n \"password_needs_reset\": false,\n \"salesforce_id\": null,\n \"default_cockpit_layout\": null,\n \"default_account_overview_layout_id\": null,\n \"default_contact_overview_layout_id\": null,\n \"default_person_overview_layout_id\": null,\n \"default_organization_overview_layout_id\": null,\n \"default_opportunity_overview_layout_id\": null,\n \"default_home_overview_layout_id\": null,\n \"bridge_calls\": false,\n \"bridge_phone_number\": null,\n \"bridge_incoming_calls\": false,\n \"bridge_incoming_phone_number\": null,\n \"current_email_verified\": true,\n \"record_calls\": true,\n \"salesforce_instance_url\": null,\n \"permission_set_id\": \"6095a711bd01d100a506d4d7\",\n \"default_use_local_numbers\": false,\n \"disable_email_linking\": null,\n \"sync_salesforce_id\": null,\n \"sync_crm_id\": null,\n \"zp_contact_id\": \"66abff979b4ed7000142aa19\",\n \"chrome_extension_downloaded\": false,\n \"zp_is_super_analytics_user\": null,\n \"email_oauth_signin_only\": true,\n \"notification_last_created_at\": null,\n \"crm_requested_to_integrate\": null,\n \"has_invited_user\": false,\n \"has_used_enrichment\": false,\n \"has_uploaded_csv\": false,\n \"has_hidden_onboarding\": false,\n \"notification_last_read_at\": null,\n \"daily_data_request_email\": false,\n \"data_request_emails\": true,\n \"daily_task_email\": true,\n \"free_data_credits_email\": true,\n \"dismiss_new_team_suggestion\": true,\n \"request_email_change_to\": null,\n \"self_identified_persona\": null,\n \"territory_is_active\": false,\n \"conversation_is_private\": null,\n \"show_deals_detail_page_updates_modal\": true,\n \"assistant_setting\": {\n \"_id\": \"66aaac5a0e951f01b37012be\",\n \"deal_size_metric\": \"amount\",\n \"inactive_account_stage_ids\": [],\n \"inactive_contact_stage_ids\": [],\n \"insight_deal_size_signals\": {},\n \"insight_sale_cycle_signals\": {},\n \"insight_win_rate_signals\": {},\n \"is_persona_recommendation_requested\": false,\n \"job_posting_locations\": [],\n \"job_posting_titles\": [],\n \"latest_funding_days\": 90,\n \"max_num_active_accounts\": 100,\n \"max_people_in_sequence_per_account\": 5,\n \"num_inactive_days_to_re_engage\": 180,\n \"persona_ids\": [\n \"65d829661453d30300a0c9e3\",\n \"65e76d7f00d9c601aed49f6c\",\n \"65e8bf1f1132a70579a84d61\",\n \"65eb62d262c9dc01c66b2675\",\n \"66200c046194fa01c707b520\",\n \"662057f7d9db7a01c7ba9960\"\n ],\n \"should_show_persona_banner\": true,\n \"success_case_account_stage_ids\": [],\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"technology_uids\": [],\n \"territory_company_size_ranges\": [],\n \"territory_location_override\": false,\n \"territory_locations\": [\n \"United States\"\n ],\n \"territory_person_locations\": [\n \"United States\"\n ],\n \"user_id\": \"66aaac5a0e951f01b37012bd\",\n \"id\": \"66aaac5a0e951f01b37012be\",\n \"key\": \"66aaac5a0e951f01b37012be\"\n },\n \"fields_fully_loaded\": true,\n \"typed_custom_fields\": null,\n \"connected_to_slack\": false,\n \"crm_email\": null,\n \"triggered_referral_campaigns\": [],\n \"enable_click_tracking\": false,\n \"enable_open_tracking\": true,\n \"should_include_unsubscribe_link\": false,\n \"enable_one_click_unsubscribe\": null,\n \"subteam_ids\": [],\n \"prospect_territory_ids\": [],\n \"toggled_on_territory_ids\": [],\n \"linked_salesforce\": null,\n \"linked_zoom_conference_account\": false,\n \"linked_bot_conference_account\": true,\n \"linked_bot_conference_account_platforms\": [\n \"google_meet\",\n \"ms_teams\"\n ],\n \"has_conference_account\": true,\n \"linked_hubspot\": false,\n \"linked_salesloft\": false,\n \"linked_crm_name\": null,\n \"chrome_extension_enabled_features\": [\n \"apollo_everywhere\",\n \"gmail\",\n \"linkedin\",\n \"salesforce\",\n \"hubspot\",\n \"google_calendar\"\n ],\n \"chrome_extension_exclude_from_websites\": [\n \"facebook.com\",\n \"youtube.com\",\n \"instagram.com\",\n \"google.com\",\n \"live.com\",\n \"yahoo.com\",\n \"notion.so\",\n \"atlassian.net\",\n \"asana.com\",\n \"typeform.com\",\n \"figma.com\"\n ],\n \"chrome_extension_everywhere_icon_horizontal_position\": \"right\",\n \"chrome_extension_everywhere_icon_vertical_position_in_vh\": 10,\n \"default_chrome_extension_log_email_send_to_salesforce\": true,\n \"default_chrome_extension_log_email_send_to_hubspot\": true,\n \"chrome_extension_auto_match_salesforce_opportunity\": true,\n \"chrome_extension_gmail_enable_email_tools\": true,\n \"enable_desktop_notifications\": false,\n \"enable_gmail_desktop_notifications\": null,\n \"default_chrome_extension_enable_reminders\": false,\n \"chrome_extension_gmail_enable_crm_sidebar\": true,\n \"show_chrome_extension_buying_intent_promo\": true,\n \"apollo_everywhere_search_count\": 0\n },\n {\n \"id\": \"66a3d80d4238fe02d2baaaaf\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"first_name\": \"Priya\",\n \"last_name\": \"Nadkarni\",\n \"title\": null,\n \"email\": \"priya.nadkarni@apollomail.io\",\n \"created_at\": \"2024-07-26T17:08:29.611Z\",\n \"credit_limit\": null,\n \"direct_dial_credit_limit\": null,\n \"export_credit_limit\": null,\n \"ai_credit_limit\": null,\n \"salesforce_account\": null,\n \"deleted\": false,\n \"opt_out_html_template\": \"If you don't want to hear from me again, please <%let me know%>.\",\n \"name\": \"Priya Nadkarni\",\n \"referral_code\": \"5Zjw_UvAwQA-wd-NfSff8b\",\n \"password_needs_reset\": false,\n \"salesforce_id\": null,\n \"default_cockpit_layout\": null,\n \"default_account_overview_layout_id\": null,\n \"default_contact_overview_layout_id\": null,\n \"default_person_overview_layout_id\": null,\n \"default_organization_overview_layout_id\": null,\n \"default_opportunity_overview_layout_id\": null,\n \"default_home_overview_layout_id\": null,\n \"bridge_calls\": false,\n \"bridge_phone_number\": null,\n \"bridge_incoming_calls\": false,\n \"bridge_incoming_phone_number\": null,\n \"current_email_verified\": true,\n \"record_calls\": true,\n \"salesforce_instance_url\": null,\n \"permission_set_id\": \"6095a711bd01d100a506d4d7\",\n \"default_use_local_numbers\": false,\n \"disable_email_linking\": null,\n \"sync_salesforce_id\": null,\n \"sync_crm_id\": null,\n \"zp_contact_id\": \"66a4b080cf1ffb000132c7e8\",\n \"chrome_extension_downloaded\": true,\n \"zp_is_super_analytics_user\": null,\n \"email_oauth_signin_only\": false,\n \"notification_last_created_at\": \"2024-08-02T15:07:37.836+00:00\",\n \"crm_requested_to_integrate\": null,\n \"has_invited_user\": false,\n \"has_used_enrichment\": false,\n \"has_uploaded_csv\": false,\n \"has_hidden_onboarding\": false,\n \"notification_last_read_at\": \"2024-07-30T23:08:32.175+00:00\",\n \"daily_data_request_email\": false,\n \"data_request_emails\": true,\n \"daily_task_email\": true,\n \"free_data_credits_email\": true,\n \"dismiss_new_team_suggestion\": true,\n \"request_email_change_to\": null,\n \"self_identified_persona\": null,\n \"territory_is_active\": false,\n \"conversation_is_private\": null,\n \"show_deals_detail_page_updates_modal\": false,\n \"assistant_setting\": {\n \"_id\": \"66a3d80d4238fe02d2baaab0\",\n \"deal_size_metric\": \"amount\",\n \"inactive_account_stage_ids\": [],\n \"inactive_contact_stage_ids\": [],\n \"insight_deal_size_signals\": {},\n \"insight_sale_cycle_signals\": {},\n \"insight_win_rate_signals\": {},\n \"is_persona_recommendation_requested\": false,\n \"job_posting_locations\": [],\n \"job_posting_titles\": [],\n \"latest_funding_days\": 90,\n \"max_num_active_accounts\": 100,\n \"max_people_in_sequence_per_account\": 5,\n \"num_inactive_days_to_re_engage\": 180,\n \"persona_ids\": [\n \"65d829661453d30300a0c9e3\",\n \"65e76d7f00d9c601aed49f6c\",\n \"65e8bf1f1132a70579a84d61\",\n \"65eb62d262c9dc01c66b2675\",\n \"66200c046194fa01c707b520\",\n \"662057f7d9db7a01c7ba9960\"\n ],\n \"should_show_persona_banner\": true,\n \"success_case_account_stage_ids\": [],\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"technology_uids\": [],\n \"territory_company_size_ranges\": [],\n \"territory_location_override\": false,\n \"territory_locations\": [\n \"United States\"\n ],\n \"territory_person_locations\": [\n \"United States\"\n ],\n \"user_id\": \"66a3d80d4238fe02d2baaaaf\",\n \"id\": \"66a3d80d4238fe02d2baaab0\",\n \"key\": \"66a3d80d4238fe02d2baaab0\"\n },\n \"fields_fully_loaded\": true,\n \"typed_custom_fields\": null,\n \"connected_to_slack\": false,\n \"crm_email\": null,\n \"triggered_referral_campaigns\": [],\n \"enable_click_tracking\": true,\n \"enable_open_tracking\": true,\n \"should_include_unsubscribe_link\": true,\n \"enable_one_click_unsubscribe\": null,\n \"subteam_ids\": [],\n \"prospect_territory_ids\": [],\n \"toggled_on_territory_ids\": [],\n \"linked_salesforce\": null,\n \"linked_zoom_conference_account\": false,\n \"linked_bot_conference_account\": true,\n \"linked_bot_conference_account_platforms\": [\n \"google_meet\",\n \"ms_teams\"\n ],\n \"has_conference_account\": true,\n \"linked_hubspot\": false,\n \"linked_salesloft\": false,\n \"linked_crm_name\": null,\n \"chrome_extension_enabled_features\": [\n \"apollo_everywhere\",\n \"gmail\",\n \"linkedin\",\n \"salesforce\",\n \"hubspot\",\n \"google_calendar\"\n ],\n \"chrome_extension_exclude_from_websites\": [\n \"facebook.com\",\n \"youtube.com\",\n \"instagram.com\",\n \"google.com\",\n \"live.com\",\n \"yahoo.com\",\n \"notion.so\",\n \"atlassian.net\",\n \"asana.com\",\n \"typeform.com\",\n \"figma.com\"\n ],\n \"chrome_extension_everywhere_icon_horizontal_position\": \"right\",\n \"chrome_extension_everywhere_icon_vertical_position_in_vh\": 10,\n \"default_chrome_extension_log_email_send_to_salesforce\": true,\n \"default_chrome_extension_log_email_send_to_hubspot\": true,\n \"chrome_extension_auto_match_salesforce_opportunity\": true,\n \"chrome_extension_gmail_enable_email_tools\": true,\n \"enable_desktop_notifications\": false,\n \"enable_gmail_desktop_notifications\": null,\n \"default_chrome_extension_enable_reminders\": false,\n \"chrome_extension_gmail_enable_crm_sidebar\": true,\n \"show_chrome_extension_buying_intent_promo\": true,\n \"apollo_everywhere_search_count\": 0\n }\n ],\n \"num_fetch_result\": null\n}"
schema:
type: object
properties:
pagination:
type: object
properties:
page:
type: string
example: '1'
per_page:
type: string
example: '3'
total_entries:
type: integer
example: 23
default: 0
total_pages:
type: integer
example: 8
default: 0
users:
type: array
items:
type: object
properties:
id:
type: string
example: 66c8db577ed7f201b25c0eef
team_id:
type: string
example: 6095a710bd01d100a506d4ac
first_name: {}
last_name: {}
title: {}
email:
type: string
example: anita.rao@apollomail.io
created_at:
type: string
example: '2024-08-23T18:56:24.067Z'
credit_limit: {}
direct_dial_credit_limit: {}
export_credit_limit: {}
ai_credit_limit: {}
salesforce_account: {}
deleted:
type: boolean
example: false
default: true
opt_out_html_template:
type: string
example: No longer interested in these messages? <%Unsubscribe%>
name:
type: string
example: ''
referral_code:
type: string
example: nzu90RCUSGkFzsavf4Efh3
password_needs_reset:
type: boolean
example: false
default: true
salesforce_id: {}
default_cockpit_layout: {}
default_account_overview_layout_id: {}
default_contact_overview_layout_id: {}
default_person_overview_layout_id: {}
default_organization_overview_layout_id: {}
default_opportunity_overview_layout_id: {}
default_home_overview_layout_id: {}
bridge_calls:
type: boolean
example: false
default: true
bridge_phone_number: {}
bridge_incoming_calls:
type: boolean
example: false
default: true
bridge_incoming_phone_number: {}
current_email_verified:
type: boolean
example: true
default: true
record_calls:
type: boolean
example: true
default: true
salesforce_instance_url: {}
permission_set_id:
type: string
example: 6170904d46a82c00c227b744
default_use_local_numbers:
type: boolean
example: false
default: true
disable_email_linking: {}
sync_salesforce_id: {}
sync_crm_id: {}
zp_contact_id:
type: string
example: 66ca3f1309358c0001ea7e4d
chrome_extension_downloaded:
type: boolean
example: false
default: true
zp_is_super_analytics_user: {}
email_oauth_signin_only:
type: boolean
example: false
default: true
notification_last_created_at: {}
crm_requested_to_integrate: {}
has_invited_user:
type: boolean
example: false
default: true
has_used_enrichment:
type: boolean
example: false
default: true
has_uploaded_csv:
type: boolean
example: false
default: true
has_hidden_onboarding:
type: boolean
example: false
default: true
notification_last_read_at: {}
daily_data_request_email:
type: boolean
example: false
default: true
data_request_emails:
type: boolean
example: true
default: true
daily_task_email:
type: boolean
example: true
default: true
free_data_credits_email:
type: boolean
example: true
default: true
dismiss_new_team_suggestion:
type: boolean
example: true
default: true
request_email_change_to: {}
self_identified_persona: {}
territory_is_active:
type: boolean
example: true
default: true
conversation_is_private: {}
show_deals_detail_page_updates_modal:
type: boolean
example: true
default: true
assistant_setting:
type: object
properties:
_id:
type: string
example: 66c8db587ed7f201b25c0ef0
deal_size_metric:
type: string
example: amount
inactive_account_stage_ids:
type: array
inactive_contact_stage_ids:
type: array
insight_deal_size_signals:
type: object
properties: {}
insight_sale_cycle_signals:
type: object
properties: {}
insight_win_rate_signals:
type: object
properties: {}
is_persona_recommendation_requested:
type: boolean
example: false
default: true
job_posting_locations:
type: array
job_posting_titles:
type: array
latest_funding_days:
type: integer
example: 90
default: 0
max_num_active_accounts:
type: integer
example: 100
default: 0
max_people_in_sequence_per_account:
type: integer
example: 5
default: 0
num_inactive_days_to_re_engage:
type: integer
example: 180
default: 0
persona_ids:
type: array
items:
type: string
example: 65d829661453d30300a0c9e3
should_show_persona_banner:
type: boolean
example: true
default: true
success_case_account_stage_ids:
type: array
team_id:
type: string
example: 6095a710bd01d100a506d4ac
technology_uids:
type: array
territory_company_size_ranges:
type: array
# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apollo-io/refs/heads/main/openapi/apollo-io-miscellaneous-api-openapi.yml