{"openapi":"3.1.0","info":{"title":"apollo-rest-api","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 230 million contacts and 30 million companies, and manage accounts, contacts, deals, sequences, tasks, calls, and conversations in your go-to-market workflows.\n\n## Base URL\n\nAll API requests are made to `https://api.apollo.io/api/v1`.\n\n## Authentication\n\n- **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).\n- **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).\n\n## Rate limits & credits\n\nRate 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).\n\nNew to the API? Start with the [Apollo API Overview](https://docs.apollo.io/docs/apollo-api-overview).","termsOfService":"https://www.apollo.io/terms/api","contact":{"name":"Apollo API Support","url":"https://docs.apollo.io/"},"version":"1.0"},"servers":[{"url":"https://api.apollo.io/api/v1"}],"tags":[{"name":"Enrichment","description":"Enrich people and company records, individually or in bulk."},{"name":"Search","description":"Search Apollo's database of people, companies, news articles, and job postings."},{"name":"Accounts","description":"Create, update, and search the companies your team tracks in Apollo."},{"name":"Contacts","description":"Create, update, and search the people your team saves in Apollo."},{"name":"Deals","description":"Create, update, and track deals in your pipeline."},{"name":"Sequences","description":"Manage outreach sequences and the contacts enrolled in them."},{"name":"Tasks","description":"Create and search tasks for your go-to-market workflows."},{"name":"Calls","description":"Log and update call records made inside or outside Apollo."},{"name":"Conversations","description":"Search, export, and retrieve recorded conversations."},{"name":"Analytics","description":"Query saved analytics reports."},{"name":"Miscellaneous","description":"Users, email accounts, lists, custom fields, notes, usage stats, and webhook results."}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"[Recommended] OAuth Access token"}}},"security":[{"bearerAuth":[]},{"apiKey":[]}],"paths":{"/people/match":{"post":{"summary":"People Enrichment","description":"This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nEnrichment is when you refresh existing records so your prospecting data is up-to-date.

Use the People Enrichment endpoint to enrich data for one person. To enrich data for up to ten people with a single API call, use the Bulk People Enrichment endpoint instead.

Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a `200` response, but the response indicates that no records have been enriched.

By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers.

You can also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.

\n\n**Webhook Response Details:**\n\n- When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details)\n\n- When passing Waterfall flags, the webhook response follows: [Waterfall webhook response Details](doc:enrich-phone-and-email-using-data-waterfall#response-details)\n\n- You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing request_id.\n\n**Webhook Requirements:**\n\n- **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS.\n\n- **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.\n\n- **Idempotency:** Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.","tags":["Enrichment"],"operationId":"people-enrichment","parameters":[{"name":"first_name","in":"query","description":"The first name of the person. This is typically used in combination with the `last_name` parameter.

Example: `tim`","schema":{"type":"string"}},{"name":"last_name","in":"query","description":"The last name of the person. This is typically used in combination with the `first_name` parameter.

Example: `zheng`","schema":{"type":"string"}},{"name":"name","in":"query","description":"The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the `first_name` and `last_name` parameters.

Example: `tim zheng`","schema":{"type":"string"}},{"name":"email","in":"query","description":"The email address of the person.

Example: `example@email.com`","schema":{"type":"string"}},{"name":"hashed_email","in":"query","description":"The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format.

Example: `8d935115b9ff4489f2d1f9249503cadf` (MD5) or `97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152` (SHA-256)","schema":{"type":"string"}},{"name":"organization_name","in":"query","description":"The name of the person's employer. This can be the current employer or a previous employer.

Example: `apollo`","schema":{"type":"string"}},{"name":"domain","in":"query","description":"The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar.

Example: `apollo.io` or `microsoft.com`","schema":{"type":"string"}},{"name":"id","in":"query","description":"The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID.

To find IDs, call the People API Search endpoint and identify the values for `person_id`.

Example: `587cf802f65125cad923a266`","schema":{"type":"string"}},{"name":"linkedin_url","in":"query","description":"The URL for the person's LinkedIn profile.

Example: `http://www.linkedin.com/in/tim-zheng-677ba010`","schema":{"type":"string"}},{"name":"run_waterfall_email","in":"query","description":"Set to true to enable email waterfall enrichment","schema":{"type":"boolean","default":false}},{"name":"run_waterfall_phone","in":"query","description":"Set to true to enable phone waterfall enrichment","schema":{"type":"boolean","default":false}},{"name":"reveal_personal_emails","in":"query","description":"Set to `true` if you want to enrich the person's data with personal emails. This potentially consumes credits as part of your Apollo pricing plan. The default value is `false`.

If a person resides in a GDPR-compliant region, Apollo will not reveal their personal email.","schema":{"type":"boolean","default":false}},{"name":"reveal_phone_number","in":"query","description":"Set to `true` if you want to enrich the person's data with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your Apollo pricing plan. The default value is `false`.

If this parameter is set to `true`, you must enter a webhook URL for the `webhook_url` parameter. Apollo will asynchronously verify phone numbers for you, then send a JSON response that includes only details about the person's phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.","schema":{"type":"boolean","default":false}},{"name":"webhook_url","in":"query","description":"If you set the `reveal_phone_number` parameter to `true`, this parameter becomes mandatory. Otherwise, do not use this parameter.

Enter the webhook URL that specifies where Apollo should send a JSON response that includes the phone number you requested. Apollo suggests testing this flow to ensure you receive the separate response with the phone number.

If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL.

Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"person":{"id":"64a7ff0cc4dfae00013df1a5","first_name":"Tim","last_name":"Zheng","name":"Tim Zheng","linkedin_url":"http://www.linkedin.com/in/tim-zheng-677ba010","title":"Founder & CEO","email_status":"verified","photo_url":"https://static.licdn.com/aero-v1/sc/h/uzfsocwl05iywf1hd7ba3915x","twitter_url":null,"github_url":null,"facebook_url":null,"extrapolated_email_confidence":null,"headline":"Founder & CEO at Apollo","email":"tim@apollo.io","organization_id":"5e66b6381e05b4008c8331b8","employment_history":[{"_id":"66d7af8c200cad0001404c1f","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5e66b6381e05b4008c8331b8","organization_name":"Apollo","raw_address":null,"start_date":"2016-01-01","title":"Founder & CEO","updated_at":null,"id":"66d7af8c200cad0001404c1f","key":"66d7af8c200cad0001404c1f"},{"_id":"66d7af8c200cad0001404c20","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2015-01-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Braingenie","raw_address":null,"start_date":"2011-01-01","title":"Founder & CEO","updated_at":null,"id":"66d7af8c200cad0001404c20","key":"66d7af8c200cad0001404c20"},{"_id":"66d7af8c200cad0001404c21","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2011-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a22f23746869331840e813","organization_name":"Citadel Investment Group","raw_address":null,"start_date":"2011-01-01","title":"Investment & Trading Associate","updated_at":null,"id":"66d7af8c200cad0001404c21","key":"66d7af8c200cad0001404c21"},{"_id":"66d7af8c200cad0001404c22","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-09-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1216169702d7fe6dfca02","organization_name":"The Boston Consulting Group","raw_address":null,"start_date":"2010-08-01","title":"Summer Associate","updated_at":null,"id":"66d7af8c200cad0001404c22","key":"66d7af8c200cad0001404c22"},{"_id":"66d7af8c200cad0001404c23","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da2e6a3f978a8000177e831","organization_name":"Goldman Sachs","raw_address":null,"start_date":"2010-06-01","title":"Summer Analyst","updated_at":null,"id":"66d7af8c200cad0001404c23","key":"66d7af8c200cad0001404c23"},{"_id":"66d7af8c200cad0001404c24","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-02-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1a06274686945fa1ffc02","organization_name":"Jane Street","raw_address":null,"start_date":"2009-12-01","title":"Trading Intern","updated_at":null,"id":"66d7af8c200cad0001404c24","key":"66d7af8c200cad0001404c24"}],"state":"California","city":"San Francisco","country":"United States","contact_id":"664fa05cf8299f0001f90876","contact":{"contact_roles":[],"id":"664fa05cf8299f0001f90876","first_name":"Roy","last_name":"Chung","name":"Roy Chung","linkedin_url":"http://www.linkedin.com/in/tim-zheng-677ba010","title":"Reaching Peak Potential πŸ’ͺβ›°οΈπŸ“ˆπŸ§ͺ️ | President","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":null,"creator_id":"66302798d03b9601c7934ec2","person_id":"64a7ff0cc4dfae00013df1a5","email_needs_tickling":null,"organization_name":"Apollo.io","source":"crm","original_source":"crm","organization_id":"5e66b6381e05b4008c8331b8","headline":"Reaching Peak Potential πŸ’ͺβ›°οΈπŸ“ˆπŸ§ͺ️ | President at FRC","photo_url":null,"present_raw_address":"New York, New York, United States","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-05-23T20:00:28.527Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"6658955877a2f20001c648ac","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+11235550158","merged_crm_ids":null,"updated_at":"2024-06-02T08:53:51.266Z","queued_for_crm_push":null,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"invisible","email":"roy@apollo.io","email_from_customer":true,"typed_custom_fields":{},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":false,"contact_rule_config_statuses":[],"source_display_name":"Imported from CRM","contact_emails":[{"email":"roy@apollo.iorrr","email_md5":"879440a4afe6515e2de11dd7c531b770","email_sha256":"d445592892011f8539d5e92394929dfda7936867c21000b21788be8a46aa73d9","email_status":"verified","email_source":null,"extrapolated_email_confidence":null,"position":0,"email_from_customer":null,"free_domain":false}],"time_zone":"America/Los_Angeles","phone_numbers":[{"raw_number":"(123) 555-0158","sanitized_number":"+11235550158","type":null,"position":0,"status":"valid_number","dnc_status":null,"dnc_other_info":null,"dialer_flags":null},{"raw_number":"(123) 555-0126","sanitized_number":"+11235550126","type":null,"position":1,"status":"valid_number","dnc_status":null,"dnc_other_info":null,"dialer_flags":null},{"raw_number":"+1-415-555-0121","sanitized_number":"+14155550121","type":null,"position":2,"status":"valid_number","dnc_status":null,"dnc_other_info":null,"dialer_flags":{"country_name":"United States","country_enabled":true,"high_risk_calling_enabled":false,"potential_high_risk_number":false}}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false},"revealed_for_current_team":true,"organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 Mission St, Floor 37, San Francisco, California 94105, US","street_address":"415 Mission St","city":"San Francisco","state":"California","postal_code":"94105-2301","country":"United States","owned_by_organization_id":null,"seo_description":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform.","short_description":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„","suborganizations":[],"num_suborganizations":0,"annual_revenue_printed":"100M","annual_revenue":100000000,"total_funding":251200000,"total_funding_printed":"251.2M","latest_funding_round_date":"2023-08-01T00:00:00.000+00:00","latest_funding_stage":"Series D","funding_events":[{"id":"6574c1ff9b797d0001fdab1b","date":"2023-08-01T00:00:00.000+00:00","news_url":null,"type":"Series D","investors":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners","amount":"100M","currency":"$"},{"id":"624f4dfec786590001768016","date":"2022-03-01T00:00:00.000+00:00","news_url":null,"type":"Series C","investors":"Sequoia Capital, Tribe Capital, Nexus Venture Partners, NewView Capital","amount":"110M","currency":"$"},{"id":"61b13677623110000186a478","date":"2021-10-01T00:00:00.000+00:00","news_url":null,"type":"Series B","investors":"Tribe Capital, NewView Capital, Nexus Venture Partners","amount":"32M","currency":"$"},{"id":"5ffe93caa54d75077c59acef","date":"2018-06-26T00:00:00.000+00:00","news_url":"https://techcrunch.com/2018/06/26/yc-grad-zenprospect-rebrands-as-apollo-lands-7-m-series-a/","type":"Series A","investors":"Nexus Venture Partners, Social Capital, Y Combinator","amount":"7M","currency":"$"},{"id":"6574c1ff9b797d0001fdab20","date":"2016-10-01T00:00:00.000+00:00","news_url":null,"type":"Other","investors":"Y Combinator, SV Angel, Social Capital, Nexus Venture Partners","amount":"2.2M","currency":"$"}],"technology_names":["AI","Android","Basis","Canva","Circle","CloudFlare Hosting","Cloudflare DNS","Drift","Gmail","Google Apps","Google Tag Manager","Google Workspace","Gravity Forms","Hubspot","Intercom","Mailchimp Mandrill","Marketo","Microsoft Office 365","Mobile Friendly","Python","Rackspace MailGun","Remote","Render","Reviews","Salesforce","Stripe","Typekit","WP Engine","Wistia","WordPress.org","Yandex Metrica","reCAPTCHA"],"current_technologies":[{"uid":"ai","name":"AI","category":"Other"},{"uid":"android","name":"Android","category":"Frameworks and Programming Languages"},{"uid":"basis","name":"Basis","category":"Advertising Networks"},{"uid":"canva","name":"Canva","category":"Content Management Platform"},{"uid":"circle","name":"Circle","category":"Financial Software"},{"uid":"cloudflare_hosting","name":"CloudFlare Hosting","category":"Hosting"},{"uid":"cloudflare_dns","name":"Cloudflare DNS","category":"Domain Name Services"},{"uid":"drift","name":"Drift","category":"Widgets"},{"uid":"gmail","name":"Gmail","category":"Email Providers"},{"uid":"google_apps","name":"Google Apps","category":"Other"},{"uid":"google_tag_manager","name":"Google Tag Manager","category":"Tag Management"},{"uid":"google workspace","name":"Google Workspace","category":"Cloud Services"},{"uid":"gravity_forms","name":"Gravity Forms","category":"Hosted Forms"},{"uid":"hubspot","name":"Hubspot","category":"Marketing Automation"},{"uid":"intercom","name":"Intercom","category":"Support and Feedback"},{"uid":"mailchimp_mandrill","name":"Mailchimp Mandrill","category":"Email Delivery"},{"uid":"marketo","name":"Marketo","category":"Marketing Automation"},{"uid":"office_365","name":"Microsoft Office 365","category":"Other"},{"uid":"mobile_friendly","name":"Mobile Friendly","category":"Other"},{"uid":"python","name":"Python","category":"Frameworks and Programming Languages"},{"uid":"rackspace_mailgun","name":"Rackspace MailGun","category":"Email Delivery"},{"uid":"remote","name":"Remote","category":"Other"},{"uid":"render","name":"Render","category":"Other"},{"uid":"reviews","name":"Reviews","category":"Customer Reviews"},{"uid":"salesforce","name":"Salesforce","category":"Customer Relationship Management"},{"uid":"stripe","name":"Stripe","category":"Payments"},{"uid":"typekit","name":"Typekit","category":"Fonts"},{"uid":"wp_engine","name":"WP Engine","category":"CMS"},{"uid":"wistia","name":"Wistia","category":"Online Video Platforms"},{"uid":"wordpress_org","name":"WordPress.org","category":"CMS"},{"uid":"yandex_metrika","name":"Yandex Metrica","category":"Analytics and Tracking"},{"uid":"recaptcha","name":"reCAPTCHA","category":"Captcha"}],"org_chart_root_people_ids":["652fc57e2802bf00010c52f8"],"org_chart_sector":"OrgChart::SectorHierarchy::Rules::IT","org_chart_removed":false,"org_chart_show_department_filter":true},"is_likely_to_engage":true,"intent_strength":null,"show_intent":false,"departments":["c_suite"],"subdepartments":["executive","founder"],"functions":["entrepreneurship"],"seniority":"founder"},"waterfall":{"status":"accepted","message":"Waterfall enrichment request accepted. Results will be sent to the provided webhook URL."},"request_id":1039995589705121900}}},"schema":{"type":"object","properties":{"request_id":{"type":"integer","example":1039995589705121900,"description":"The request ID for the enrichment request. Save this ID to map this request with the corresponding webhook result."},"person":{"type":"object","properties":{"id":{"type":"string","example":"64a7ff0cc4dfae00013df1a5"},"first_name":{"type":"string","example":"Tim"},"last_name":{"type":"string","example":"Zheng"},"name":{"type":"string","example":"Tim Zheng"},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/in/tim-zheng-677ba010"},"title":{"type":"string","example":"Founder & CEO"},"email_status":{"type":"string","example":"verified"},"photo_url":{"type":"string","example":"https://static.licdn.com/aero-v1/sc/h/uzfsocwl05iywf1hd7ba3915x"},"twitter_url":{},"github_url":{},"facebook_url":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"headline":{"type":"string","example":"Founder & CEO at Apollo"},"email":{"type":"string","example":"tim@apollo.io"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"employment_history":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"66d7af8c200cad0001404c1f"},"created_at":{},"current":{"type":"boolean","example":true,"default":true},"degree":{},"description":{},"emails":{},"end_date":{},"grade_level":{},"kind":{},"major":{},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"organization_name":{"type":"string","example":"Apollo"},"raw_address":{},"start_date":{"type":"string","example":"2016-01-01"},"title":{"type":"string","example":"Founder & CEO"},"updated_at":{},"id":{"type":"string","example":"66d7af8c200cad0001404c1f"},"key":{"type":"string","example":"66d7af8c200cad0001404c1f"}}}},"state":{"type":"string","example":"California"},"city":{"type":"string","example":"San Francisco"},"country":{"type":"string","example":"United States"},"contact_id":{"type":"string","example":"664fa05cf8299f0001f90876"},"contact":{"type":"object","properties":{"contact_roles":{"type":"array"},"id":{"type":"string","example":"664fa05cf8299f0001f90876"},"first_name":{"type":"string","example":"Roy"},"last_name":{"type":"string","example":"Chung"},"name":{"type":"string","example":"Roy Chung"},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/in/tim-zheng-677ba010"},"title":{"type":"string","example":"Reaching Peak Potential πŸ’ͺβ›°οΈπŸ“ˆπŸ§ͺ️ | President"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4ae"},"owner_id":{},"creator_id":{"type":"string","example":"66302798d03b9601c7934ec2"},"person_id":{"type":"string","example":"64a7ff0cc4dfae00013df1a5"},"email_needs_tickling":{},"organization_name":{"type":"string","example":"Apollo.io"},"source":{"type":"string","example":"crm"},"original_source":{"type":"string","example":"crm"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"headline":{"type":"string","example":"Reaching Peak Potential πŸ’ͺβ›°οΈπŸ“ˆπŸ§ͺ️ | President at FRC"},"photo_url":{},"present_raw_address":{"type":"string","example":"New York, New York, United States"},"linkedin_uid":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"salesforce_id":{},"salesforce_lead_id":{},"salesforce_contact_id":{},"salesforce_account_id":{},"crm_owner_id":{},"created_at":{"type":"string","example":"2024-05-23T20:00:28.527Z"},"emailer_campaign_ids":{"type":"array"},"direct_dial_status":{},"direct_dial_enrichment_failed_at":{},"email_status":{"type":"string","example":"verified"},"email_source":{},"account_id":{"type":"string","example":"6658955877a2f20001c648ac"},"last_activity_date":{},"hubspot_vid":{},"hubspot_company_id":{},"crm_id":{},"sanitized_phone":{"type":"string","example":"+11235550158"},"merged_crm_ids":{},"updated_at":{"type":"string","example":"2024-06-02T08:53:51.266Z"},"queued_for_crm_push":{},"suggested_from_rule_engine_config_id":{},"email_unsubscribed":{},"label_ids":{"type":"array"},"has_pending_email_arcgate_request":{"type":"boolean","example":false,"default":true},"has_email_arcgate_request":{"type":"boolean","example":false,"default":true},"existence_level":{"type":"string","example":"invisible"},"email":{"type":"string","example":"roy@apollo.io"},"email_from_customer":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"crm_record_url":{},"email_status_unavailable_reason":{},"email_true_status":{"type":"string","example":"Verified"},"updated_email_true_status":{"type":"boolean","example":false,"default":true},"contact_rule_config_statuses":{"type":"array"},"source_display_name":{"type":"string","example":"Imported from CRM"},"contact_emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"roy@apollo.iorrr"},"email_md5":{"type":"string","example":"879440a4afe6515e2de11dd7c531b770"},"email_sha256":{"type":"string","example":"d445592892011f8539d5e92394929dfda7936867c21000b21788be8a46aa73d9"},"email_status":{"type":"string","example":"verified"},"email_source":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"position":{"type":"integer","example":0,"default":0},"email_from_customer":{},"free_domain":{"type":"boolean","example":false,"default":true}}}},"time_zone":{"type":"string","example":"America/Los_Angeles"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"raw_number":{"type":"string","example":"(123) 555-0158"},"sanitized_number":{"type":"string","example":"+11235550158"},"type":{},"position":{"type":"integer","example":0,"default":0},"status":{"type":"string","example":"valid_number"},"dnc_status":{},"dnc_other_info":{},"dialer_flags":{}}}},"account_phone_note":{},"free_domain":{"type":"boolean","example":false,"default":true},"is_likely_to_engage":{"type":"boolean","example":false,"default":true}}},"revealed_for_current_team":{"type":"boolean","example":true,"default":true},"organization":{"type":"object","properties":{"id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"industry":{"type":"string","example":"information technology & services"},"keywords":{"type":"array","items":{"type":"string","example":"sales engagement"}},"estimated_num_employees":{"type":"integer","example":1600,"default":0},"industries":{"type":"array","items":{"type":"string","example":"information technology & services"}},"secondary_industries":{"type":"array"},"snippets_loaded":{"type":"boolean","example":true,"default":true},"industry_tag_id":{"type":"string","example":"5567cd4773696439b10b0000"},"industry_tag_hash":{"type":"object","properties":{"information technology & services":{"type":"string","example":"5567cd4773696439b10b0000"}}},"retail_location_count":{"type":"integer","example":0,"default":0},"raw_address":{"type":"string","example":"415 Mission St, Floor 37, San Francisco, California 94105, US"},"street_address":{"type":"string","example":"415 Mission St"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"California"},"postal_code":{"type":"string","example":"94105-2301"},"country":{"type":"string","example":"United States"},"owned_by_organization_id":{},"seo_description":{"type":"string","example":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform."},"short_description":{"type":"string","example":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„"},"suborganizations":{"type":"array"},"num_suborganizations":{"type":"integer","example":0,"default":0},"annual_revenue_printed":{"type":"string","example":"100M"},"annual_revenue":{"type":"integer","example":100000000,"default":0},"total_funding":{"type":"integer","example":251200000,"default":0},"total_funding_printed":{"type":"string","example":"251.2M"},"latest_funding_round_date":{"type":"string","example":"2023-08-01T00:00:00.000+00:00"},"latest_funding_stage":{"type":"string","example":"Series D"},"funding_events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6574c1ff9b797d0001fdab1b"},"date":{"type":"string","example":"2023-08-01T00:00:00.000+00:00"},"news_url":{},"type":{"type":"string","example":"Series D"},"investors":{"type":"string","example":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners"},"amount":{"type":"string","example":"100M"},"currency":{"type":"string","example":"$"}}}},"technology_names":{"type":"array","items":{"type":"string","example":"AI"}},"current_technologies":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","example":"ai"},"name":{"type":"string","example":"AI"},"category":{"type":"string","example":"Other"}}}},"org_chart_root_people_ids":{"type":"array","items":{"type":"string","example":"652fc57e2802bf00010c52f8"}},"org_chart_sector":{"type":"string","example":"OrgChart::SectorHierarchy::Rules::IT"},"org_chart_removed":{"type":"boolean","example":false,"default":true},"org_chart_show_department_filter":{"type":"boolean","example":true,"default":true}}},"is_likely_to_engage":{"type":"boolean","example":true,"default":true},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"departments":{"type":"array","items":{"type":"string","example":"c_suite"}},"subdepartments":{"type":"array","items":{"type":"string","example":"executive"}},"functions":{"type":"array","items":{"type":"string","example":"entrepreneurship"}},"seniority":{"type":"string","example":"founder"}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"message":"The maximum number of api calls allowed for api/v1/people/match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/people/match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/people/bulk_match":{"post":{"summary":"Bulk People Enrichment","description":"This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nEnrichment is when you refresh existing records so your prospecting data is up-to-date.

Use the Bulk People Enrichment endpoint to enrich data for up to ten people with a single API call. To enrich data for a single person, use the People Enrichment endpoint instead.

Apollo relies on the information you pass via the endpoint's parameters to identify the correct people to enrich. When you provide more information, Apollo is more likely to find matches within its database. If you only provide general information, such as a name without a domain or email address, you may receive a `200` response, but the response indicates that no records have been enriched. The details for each person should be passed as an object with the `details[]` array.

By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers. If you set either of these parameters to `true`, Apollo attempts to provide emails or phone numbers for all matches.

You can use also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.

\n\n**Webhook Response Details:**\n\n- When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details)\n\n- When passing Waterfall flags, the webhook response follows: [Waterfall webhook response details](doc:enrich-phone-and-email-using-data-waterfall#response-details)\n\n- You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing request_id.\n\n**Webhook Requirements:**\n\n- **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS.\n\n- **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo.\n\n- **Idempotency:** Apollo may retry webhook calls. Your endpoint should be idempotent to handle duplicate payloads safely.","tags":["Enrichment"],"operationId":"bulk-people-enrichment","parameters":[{"name":"run_waterfall_email","in":"query","description":"Set to true to enable email waterfall enrichment","schema":{"type":"boolean","default":false}},{"name":"run_waterfall_phone","in":"query","description":"Set to true to enable phone waterfall enrichment","schema":{"type":"boolean","default":false}},{"name":"reveal_personal_emails","in":"query","description":"Set to `true` if you want to enrich all matched people with personal emails. This potentially consumes credits as part of your Apollo pricing plan. The default value is `false`.

If a person resides in a GDPR-compliant region, Apollo will not reveal their personal email.","schema":{"type":"boolean","default":false}},{"name":"reveal_phone_number","in":"query","description":"Set to `true` if you want to enrich the data of all matched people with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your Apollo pricing plan. The default value is `false`.

If this parameter is set to `true`, you must enter a webhook URL for the `webhook_url` parameter. Apollo will asynchronously verify phone numbers for you, then send a JSON response that includes only details about the phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.","schema":{"type":"boolean","default":false}},{"name":"webhook_url","in":"query","description":"If you set the `reveal_phone_number` parameter to `true`, this parameter becomes mandatory. Otherwise, do not use this parameter.

Enter the webhook URL that specifies where Apollo should send a JSON response that includes the phone number you requested. Apollo suggests testing this flow to ensure you receive the separate response with the phone number.

If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL.

Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["details"],"properties":{"details":{"type":"array","description":"Provide info for each person you want to enrich as an object within this array. Add up to 10 people.","items":{"properties":{"first_name":{"type":"string","description":"The first name of the person. This is typically used in combination with the `last_name` parameter.

Example: `tim`"},"last_name":{"type":"string","description":"The last name of the person. This is typically used in combination with the `first_name` parameter.

Example: `zheng`"},"name":{"type":"string","description":"The full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the `first_name` and `last_name` parameters.

Example: `tim zheng`"},"email":{"type":"string","description":"The email address of the person.

Example: `example@email.com`"},"hashed_email":{"type":"string","description":"The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format.

Example: `8d935115b9ff4489f2d1f9249503cadf` (MD5) or `97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152` (SHA-256)"},"organization_name":{"type":"string","description":"The name of the person's employer. This can be the current employer or a previous employer.

Example: `apollo`"},"domain":{"type":"string","description":"The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar.

Example: `apollo.io` or `microsoft.com`"},"id":{"type":"string","description":"The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID.

To find IDs, call the People API Search endpoint and identify the values for `person_id`.

Example: `587cf802f65125cad923a266`"},"linkedin_url":{"type":"string","description":"The URL for the person's LinkedIn profile.

Example: `http://www.linkedin.com/in/tim-zheng-677ba010`"}},"type":"object"}}}},"examples":{"Apollo ID to enrich data":{"summary":"Apollo ID to enrich data","value":{"details":[{"id":"64a7ff0cc4dfae00013df1a5"}]}},"Sample request body":{"summary":"Sample request body","value":{"details":[{"first_name":"tim","last_name":"zheng","name":"tim zheng","email":"tim@apollo.io","hashed_email":"8d935115b9ff4489f2d1f9249503cadf","organization_name":"apollo","domain":"apollo.io","id":"64a7ff0cc4dfae00013df1a5","linkedin_url":"http://www.linkedin.com/in/tim-zheng-677ba010"}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"status":"success","error_code":null,"error_message":null,"total_requested_enrichments":3,"unique_enriched_records":3,"missing_records":0,"credits_consumed":3,"matches":[{"id":"64a7ff0cc4dfae00013df1a5","first_name":"Tim","last_name":"Zheng","name":"Tim Zheng","linkedin_url":"http://www.linkedin.com/in/tim-zheng-677ba010","title":"Founder & CEO","email_status":"verified","photo_url":"https://static.licdn.com/aero-v1/sc/h/uzfsocwl05iywf1hd7ba3915x","twitter_url":null,"github_url":null,"facebook_url":null,"extrapolated_email_confidence":null,"headline":"Founder & CEO at Apollo","email":"tim@apollo.io","organization_id":"5e66b6381e05b4008c8331b8","employment_history":[{"_id":"66d8c632580636000195735f","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5e66b6381e05b4008c8331b8","organization_name":"Apollo","raw_address":null,"start_date":"2016-01-01","title":"Founder & CEO","updated_at":null,"id":"66d8c632580636000195735f","key":"66d8c632580636000195735f"},{"_id":"66d8c6325806360001957360","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2015-01-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Braingenie","raw_address":null,"start_date":"2011-01-01","title":"Founder & CEO","updated_at":null,"id":"66d8c6325806360001957360","key":"66d8c6325806360001957360"},{"_id":"66d8c6325806360001957361","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2011-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a22f23746869331840e813","organization_name":"Citadel Investment Group","raw_address":null,"start_date":"2011-01-01","title":"Investment & Trading Associate","updated_at":null,"id":"66d8c6325806360001957361","key":"66d8c6325806360001957361"},{"_id":"66d8c6325806360001957362","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-09-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1216169702d7fe6dfca02","organization_name":"The Boston Consulting Group","raw_address":null,"start_date":"2010-08-01","title":"Summer Associate","updated_at":null,"id":"66d8c6325806360001957362","key":"66d8c6325806360001957362"},{"_id":"66d8c6325806360001957363","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da2e6a3f978a8000177e831","organization_name":"Goldman Sachs","raw_address":null,"start_date":"2010-06-01","title":"Summer Analyst","updated_at":null,"id":"66d8c6325806360001957363","key":"66d8c6325806360001957363"},{"_id":"66d8c6325806360001957364","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-02-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1a06274686945fa1ffc02","organization_name":"Jane Street","raw_address":null,"start_date":"2009-12-01","title":"Trading Intern","updated_at":null,"id":"66d8c6325806360001957364","key":"66d8c6325806360001957364"}],"state":"California","city":"San Francisco","country":"United States","organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 Mission St, Floor 37, San Francisco, California 94105, US","street_address":"415 Mission St","city":"San Francisco","state":"California","postal_code":"94105-2301","country":"United States"},"is_likely_to_engage":true,"account_id":"63f53afe4ceeca00016bdd2f","account":{"id":"63f53afe4ceeca00016bdd2f","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":"+1(202) 555-0114","linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","domain":"apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"csv_import","original_source":"salesforce","creator_id":null,"owner_id":"66aaac5a0e951f01b37012bd","created_at":"2023-02-21T21:43:26.351Z","phone_status":"no_status","hubspot_id":null,"salesforce_id":"001niCRAYZ4Ho6GTKv","crm_owner_id":"005Ux6UIthHN0CrhuW","parent_account_id":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"664f9eef1fded70001e4983e","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"664f9eef1fded70001e4983e","key":"664f9eef1fded70001e4983e"}],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Uploaded from CSV","salesforce_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv","crm_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv"},"departments":["c_suite"],"subdepartments":["executive","founder"],"seniority":"founder","functions":["entrepreneurship"],"intent_strength":null,"show_intent":false,"revealed_for_current_team":true},{"id":"587cf802f65125cad923a266","first_name":"Brian","last_name":"Calderwood","name":"Brian Calderwood","linkedin_url":"http://www.linkedin.com/in/brian-calderwood-9d4f2a7b","title":"VP @ Apollo.io | Publisher","email_status":"verified","photo_url":"https://media.licdn.com/dms/image/CecgK0ciYEs1B13anm/profile-displayphoto-shrink_200_200/0/f3eec52547190?e=2147483647&v=beta&t=YN5V2inb59uZik-3W350-0cX0Khe34VdvF0S1X8k2jV","twitter_url":null,"github_url":null,"facebook_url":null,"extrapolated_email_confidence":null,"headline":"VP @ Apollo.io | Publisher at Backlit Comics","email":"brian.calderwood@apollo.io","organization_id":"5e66b6381e05b4008c8331b8","employment_history":[{"_id":"66d9e67b86199f0001b24246","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5e66b6381e05b4008c8331b8","organization_name":"Apollo.io","raw_address":null,"start_date":"2023-08-01","title":"VP @ Apollo.io | Publisher","updated_at":null,"id":"66d9e67b86199f0001b24246","key":"66d9e67b86199f0001b24246"},{"_id":"66d9e67b86199f0001b24247","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2023-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"5e66b6381e05b4008c8331b8","organization_name":"Apollo.io","raw_address":null,"start_date":"2022-12-01","title":"Head of Content Marketing & Customer Education","updated_at":null,"id":"66d9e67b86199f0001b24247","key":"66d9e67b86199f0001b24247"},{"_id":"66d9e67b86199f0001b24248","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2022-12-01","grade_level":null,"kind":null,"major":null,"organization_id":"5ff745ebd2b12300da0d8c49","organization_name":"Teamflow","raw_address":null,"start_date":"2022-01-01","title":"Head of Revenue","updated_at":null,"id":"66d9e67b86199f0001b24248","key":"66d9e67b86199f0001b24248"},{"_id":"66d9e67b86199f0001b24249","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2022-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"5ff745ebd2b12300da0d8c49","organization_name":"Teamflow","raw_address":null,"start_date":"2021-12-01","title":"Head Of Marketing","updated_at":null,"id":"66d9e67b86199f0001b24249","key":"66d9e67b86199f0001b24249"},{"_id":"66d9e67b86199f0001b2424a","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2021-11-01","grade_level":null,"kind":null,"major":null,"organization_id":"62b0a223c6e72300ca47b474","organization_name":"Autodesk","raw_address":null,"start_date":"2021-04-01","title":"Sr. Growth Marketing Manager","updated_at":null,"id":"66d9e67b86199f0001b2424a","key":"66d9e67b86199f0001b2424a"},{"_id":"66d9e67b86199f0001b2424b","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2021-04-01","grade_level":null,"kind":null,"major":null,"organization_id":"62b0a223c6e72300ca47b474","organization_name":"Autodesk","raw_address":null,"start_date":"2019-03-01","title":"Growth Marketing Manager","updated_at":null,"id":"66d9e67b86199f0001b2424b","key":"66d9e67b86199f0001b2424b"},{"_id":"66d9e67b86199f0001b2424c","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2019-03-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"BuildingConnected, an Autodesk product","raw_address":null,"start_date":"2018-10-01","title":"Marketing Automation Manager","updated_at":null,"id":"66d9e67b86199f0001b2424c","key":"66d9e67b86199f0001b2424c"},{"_id":"66d9e67b86199f0001b2424d","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2018-08-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"SpotMe Lending","raw_address":null,"start_date":"2018-03-01","title":"Co-Founder, Product & Marketing","updated_at":null,"id":"66d9e67b86199f0001b2424d","key":"66d9e67b86199f0001b2424d"},{"_id":"66d9e67b86199f0001b2424e","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2016-06-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"inDinero","raw_address":null,"start_date":"2015-11-01","title":"Director of Account Management","updated_at":null,"id":"66d9e67b86199f0001b2424e","key":"66d9e67b86199f0001b2424e"},{"_id":"66d9e67b86199f0001b2424f","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2015-11-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"inDinero","raw_address":null,"start_date":"2014-09-01","title":"Director of Enterprise Sales","updated_at":null,"id":"66d9e67b86199f0001b2424f","key":"66d9e67b86199f0001b2424f"},{"_id":"66d9e67b86199f0001b24250","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2014-07-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da61143b495bc000168bdca","organization_name":"FXCM","raw_address":null,"start_date":"2013-06-01","title":"Forex Sales Broker","updated_at":null,"id":"66d9e67b86199f0001b24250","key":"66d9e67b86199f0001b24250"},{"_id":"66d9e67b86199f0001b24251","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2012-12-01","grade_level":null,"kind":null,"major":null,"organization_id":"5d0a6a7da3ae6121868fabb8","organization_name":"CreditRepair.com","raw_address":null,"start_date":"2012-02-01","title":"Sales Team Leader","updated_at":null,"id":"66d9e67b86199f0001b24251","key":"66d9e67b86199f0001b24251"},{"_id":"66d9e67b86199f0001b24252","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2011-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1b7477468694f8f25ae0a","organization_name":"Progrexion","raw_address":null,"start_date":"2011-04-01","title":"Inbound Sales Representative","updated_at":null,"id":"66d9e67b86199f0001b24252","key":"66d9e67b86199f0001b24252"}],"state":"California","city":"San Francisco","country":"United States","organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 Mission St, Floor 37, San Francisco, California 94105, US","street_address":"415 Mission St","city":"San Francisco","state":"California","postal_code":"94105-2301","country":"United States"},"is_likely_to_engage":false,"account_id":"63f53afe4ceeca00016bdd2f","account":{"id":"63f53afe4ceeca00016bdd2f","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":"+1(202) 555-0114","linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","domain":"apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"csv_import","original_source":"salesforce","creator_id":null,"owner_id":"66aaac5a0e951f01b37012bd","created_at":"2023-02-21T21:43:26.351Z","phone_status":"no_status","hubspot_id":null,"salesforce_id":"001niCRAYZ4Ho6GTKv","crm_owner_id":"005Ux6UIthHN0CrhuW","parent_account_id":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"664f9eef1fded70001e4983e","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"664f9eef1fded70001e4983e","key":"664f9eef1fded70001e4983e"}],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Uploaded from CSV","salesforce_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv","crm_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv"},"departments":[],"subdepartments":[],"seniority":"vp","functions":[],"intent_strength":null,"show_intent":false,"revealed_for_current_team":true},{"id":"611d751fa587f80001890daa","first_name":"Nadia","last_name":"Calloway","name":"Nadia Calloway","linkedin_url":"http://www.linkedin.com/in/nadia-calloway-7b1e9c34","title":"Product Marketing Leader at Apollo.io, formerly","email_status":"verified","photo_url":"https://media.licdn.com/dms/image/dSl0qLTOhkATTjWifX/profile-displayphoto-shrink_200_200/0/0c67e82df5a85?e=2147483647&v=beta&t=OWUxN1v0BP0_cdfC4wbvpCdgmoDspEqGGqyrp-Q1Hmg","twitter_url":null,"github_url":null,"facebook_url":null,"extrapolated_email_confidence":null,"headline":"Product Marketing Leader at Apollo.io, formerly @ Gainsight, Marketo, Podium","email":"nadia.calloway@apollo.io","organization_id":"5e66b6381e05b4008c8331b8","employment_history":[{"_id":"66d9520b7fea3e000137e512","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5e66b6381e05b4008c8331b8","organization_name":"Apollo.io","raw_address":null,"start_date":"2023-06-01","title":"Product Marketing Leader at Apollo.io, formerly","updated_at":null,"id":"66d9520b7fea3e000137e512","key":"66d9520b7fea3e000137e512"},{"_id":"66d9520b7fea3e000137e513","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2023-05-01","grade_level":null,"kind":null,"major":null,"organization_id":"5b84e1f6f874f7499946da53","organization_name":"Podium","raw_address":null,"start_date":"2021-10-01","title":"VP, Product Marketing & Brand","updated_at":null,"id":"66d9520b7fea3e000137e513","key":"66d9520b7fea3e000137e513"},{"_id":"66d9520b7fea3e000137e514","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2021-10-01","grade_level":null,"kind":null,"major":null,"organization_id":"5b84e1f6f874f7499946da53","organization_name":"Podium","raw_address":null,"start_date":"2020-11-01","title":"Sr. Director, Head of Product Marketing","updated_at":null,"id":"66d9520b7fea3e000137e514","key":"66d9520b7fea3e000137e514"},{"_id":"66d9520b7fea3e000137e515","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2020-11-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da4169904a137000118172a","organization_name":"Gainsight","raw_address":null,"start_date":"2020-06-01","title":"Head of Product Marketing","updated_at":null,"id":"66d9520b7fea3e000137e515","key":"66d9520b7fea3e000137e515"},{"_id":"66d9520b7fea3e000137e516","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2020-06-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da4169904a137000118172a","organization_name":"Gainsight","raw_address":null,"start_date":"2019-10-01","title":"Sr. Director, Product Marketing","updated_at":null,"id":"66d9520b7fea3e000137e516","key":"66d9520b7fea3e000137e516"},{"_id":"66d9520b7fea3e000137e517","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2019-10-01","grade_level":null,"kind":null,"major":null,"organization_id":"5da4169904a137000118172a","organization_name":"Gainsight","raw_address":null,"start_date":"2018-09-01","title":"Director of Product Marketing","updated_at":null,"id":"66d9520b7fea3e000137e517","key":"66d9520b7fea3e000137e517"},{"_id":"66d9520b7fea3e000137e518","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2018-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"5ce358f53acc510bd70fee14","organization_name":"Marketo, an Adobe company","raw_address":null,"start_date":"2018-01-01","title":"Director of Solutions & Content Marketing (Head of Global Content Marketing)","updated_at":null,"id":"66d9520b7fea3e000137e518","key":"66d9520b7fea3e000137e518"},{"_id":"66d9520b7fea3e000137e519","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2018-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"5ce358f53acc510bd70fee14","organization_name":"Marketo, an Adobe company","raw_address":null,"start_date":"2017-01-01","title":"Principal, Commercial Product Marketing","updated_at":null,"id":"66d9520b7fea3e000137e519","key":"66d9520b7fea3e000137e519"},{"_id":"66d9520b7fea3e000137e51a","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2017-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"5ce358f53acc510bd70fee14","organization_name":"Marketo, an Adobe company","raw_address":null,"start_date":"2015-08-01","title":"Senior Product Marketing Manager","updated_at":null,"id":"66d9520b7fea3e000137e51a","key":"66d9520b7fea3e000137e51a"},{"_id":"66d9520b7fea3e000137e51b","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2015-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"5e596f42110b1400019edb6a","organization_name":"PeopleFluent","raw_address":null,"start_date":"2015-01-01","title":"Product Marketing Manager","updated_at":null,"id":"66d9520b7fea3e000137e51b","key":"66d9520b7fea3e000137e51b"},{"_id":"66d9520b7fea3e000137e51c","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2014-12-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Harte Hanks / The Aberdeen Group","raw_address":null,"start_date":"2014-05-01","title":"Product Marketing Manager","updated_at":null,"id":"66d9520b7fea3e000137e51c","key":"66d9520b7fea3e000137e51c"},{"_id":"66d9520b7fea3e000137e51d","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2014-05-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Harte Hanks / The Aberdeen Group","raw_address":null,"start_date":"2013-12-01","title":"Product Marketing Specialist","updated_at":null,"id":"66d9520b7fea3e000137e51d","key":"66d9520b7fea3e000137e51d"},{"_id":"66d9520b7fea3e000137e51e","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2013-12-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"ConnectEDU (formerly Experience, Inc.)","raw_address":null,"start_date":"2013-06-01","title":"Director of Marketing","updated_at":null,"id":"66d9520b7fea3e000137e51e","key":"66d9520b7fea3e000137e51e"},{"_id":"66d9520b7fea3e000137e51f","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2013-06-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"ConnectEDU (formerly Experience, Inc.)","raw_address":null,"start_date":"2012-09-01","title":"Marketing Manager","updated_at":null,"id":"66d9520b7fea3e000137e51f","key":"66d9520b7fea3e000137e51f"},{"_id":"66d9520b7fea3e000137e520","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2012-09-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"ConnectEDU (formerly Experience, Inc.)","raw_address":null,"start_date":"2012-04-01","title":"Solutions Consultant","updated_at":null,"id":"66d9520b7fea3e000137e520","key":"66d9520b7fea3e000137e520"},{"_id":"66d9520b7fea3e000137e521","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2012-04-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"ConnectEDU (formerly Experience, Inc.)","raw_address":null,"start_date":"2011-03-01","title":"Account Executive","updated_at":null,"id":"66d9520b7fea3e000137e521","key":"66d9520b7fea3e000137e521"}],"state":"Georgia","city":"Atlanta","country":"United States","organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 Mission St, Floor 37, San Francisco, California 94105, US","street_address":"415 Mission St","city":"San Francisco","state":"California","postal_code":"94105-2301","country":"United States"},"is_likely_to_engage":false,"account_id":"63f53afe4ceeca00016bdd2f","account":{"id":"63f53afe4ceeca00016bdd2f","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":"+1(202) 555-0114","linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","domain":"apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"csv_import","original_source":"salesforce","creator_id":null,"owner_id":"66aaac5a0e951f01b37012bd","created_at":"2023-02-21T21:43:26.351Z","phone_status":"no_status","hubspot_id":null,"salesforce_id":"001niCRAYZ4Ho6GTKv","crm_owner_id":"005Ux6UIthHN0CrhuW","parent_account_id":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"664f9eef1fded70001e4983e","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"664f9eef1fded70001e4983e","key":"664f9eef1fded70001e4983e"}],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Uploaded from CSV","salesforce_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv","crm_record_url":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv"},"departments":["master_marketing"],"subdepartments":["marketing","product_marketing"],"seniority":"entry","functions":["marketing"],"intent_strength":null,"show_intent":false,"revealed_for_current_team":true}],"waterfall":{"status":"accepted","message":"Waterfall enrichment request accepted. Results will be sent to the provided webhook URL."},"request_id":1039995589705121900}}},"schema":{"type":"object","properties":{"request_id":{"type":"integer","example":1039995589705121900,"description":"The request ID for the enrichment request. Save this ID to map this request with the corresponding webhook result."},"status":{"type":"string","example":"success"},"error_code":{},"error_message":{},"total_requested_enrichments":{"type":"integer","example":3,"default":0},"unique_enriched_records":{"type":"integer","example":3,"default":0},"missing_records":{"type":"integer","example":0,"default":0},"credits_consumed":{"type":"integer","example":3,"default":0},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"64a7ff0cc4dfae00013df1a5"},"first_name":{"type":"string","example":"Tim"},"last_name":{"type":"string","example":"Zheng"},"name":{"type":"string","example":"Tim Zheng"},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/in/tim-zheng-677ba010"},"title":{"type":"string","example":"Founder & CEO"},"email_status":{"type":"string","example":"verified"},"photo_url":{"type":"string","example":"https://static.licdn.com/aero-v1/sc/h/uzfsocwl05iywf1hd7ba3915x"},"twitter_url":{},"github_url":{},"facebook_url":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"headline":{"type":"string","example":"Founder & CEO at Apollo"},"email":{"type":"string","example":"tim@apollo.io"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"employment_history":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"66d8c632580636000195735f"},"created_at":{},"current":{"type":"boolean","example":true,"default":true},"degree":{},"description":{},"emails":{},"end_date":{},"grade_level":{},"kind":{},"major":{},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"organization_name":{"type":"string","example":"Apollo"},"raw_address":{},"start_date":{"type":"string","example":"2016-01-01"},"title":{"type":"string","example":"Founder & CEO"},"updated_at":{},"id":{"type":"string","example":"66d8c632580636000195735f"},"key":{"type":"string","example":"66d8c632580636000195735f"}}}},"state":{"type":"string","example":"California"},"city":{"type":"string","example":"San Francisco"},"country":{"type":"string","example":"United States"},"organization":{"type":"object","properties":{"id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"industry":{"type":"string","example":"information technology & services"},"keywords":{"type":"array","items":{"type":"string","example":"sales engagement"}},"estimated_num_employees":{"type":"integer","example":1600,"default":0},"industries":{"type":"array","items":{"type":"string","example":"information technology & services"}},"secondary_industries":{"type":"array"},"snippets_loaded":{"type":"boolean","example":true,"default":true},"industry_tag_id":{"type":"string","example":"5567cd4773696439b10b0000"},"industry_tag_hash":{"type":"object","properties":{"information technology & services":{"type":"string","example":"5567cd4773696439b10b0000"}}},"retail_location_count":{"type":"integer","example":0,"default":0},"raw_address":{"type":"string","example":"415 Mission St, Floor 37, San Francisco, California 94105, US"},"street_address":{"type":"string","example":"415 Mission St"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"California"},"postal_code":{"type":"string","example":"94105-2301"},"country":{"type":"string","example":"United States"}}},"is_likely_to_engage":{"type":"boolean","example":true,"default":true},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"account":{"type":"object","properties":{"id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{"type":"string","example":"+1(202) 555-0114"},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"domain":{"type":"string","example":"apollo.io"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"account_stage_id":{},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"salesforce"},"creator_id":{},"owner_id":{"type":"string","example":"66aaac5a0e951f01b37012bd"},"created_at":{"type":"string","example":"2023-02-21T21:43:26.351Z"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{"type":"string","example":"001niCRAYZ4Ho6GTKv"},"crm_owner_id":{"type":"string","example":"005Ux6UIthHN0CrhuW"},"parent_account_id":{},"sanitized_phone":{"type":"string","example":"+12025550114"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"664f9eef1fded70001e4983e"},"created_at":{},"rule_action_config_id":{"type":"string","example":"65735e0ea63d2700faba5c6e"},"rule_config_id":{"type":"string","example":"65735e0ea63d2700faba5c6f"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"664f9eef1fded70001e4983e"},"key":{"type":"string","example":"664f9eef1fded70001e4983e"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6504905b21ba8e00a334eb0f"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"salesforce_record_url":{"type":"string","example":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv"},"crm_record_url":{"type":"string","example":"https://saas-drive-2207.my.salesforce.com/001niCRAYZ4Ho6GTKv"}}},"departments":{"type":"array","items":{"type":"string","example":"c_suite"}},"subdepartments":{"type":"array","items":{"type":"string","example":"executive"}},"seniority":{"type":"string","example":"founder"},"functions":{"type":"array","items":{"type":"string","example":"entrepreneurship"}},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"revealed_for_current_team":{"type":"boolean","example":true,"default":true}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Add people to enrich":{"value":{"status":"failed","error_code":"INVALID_REQUEST","error_message":"invalid request, missing details"}},"More than 10 people":{"value":{"status":"failed","error_code":"RECORD_LIMIT_EXCEEDED","error_message":"domain count cannot be more than 10"}}},"schema":{"oneOf":[{"title":"Add people to enrich","type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"INVALID_REQUEST"},"error_message":{"type":"string","example":"invalid request, missing details"}}},{"title":"More than 10 people","type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"RECORD_LIMIT_EXCEEDED"},"error_message":{"type":"string","example":"domain count cannot be more than 10"}}}]}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"status\": \"failed\",\n \"error_code\": \"UNKNOWN_ERROR\",\n \"error_message\": \"no implicit conversion of Symbol into Integer\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"UNKNOWN_ERROR"},"error_message":{"type":"string","example":"undefined method `length' for an instance of ActionController::Parameters"}}},{"type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"UNKNOWN_ERROR"},"error_message":{"type":"string","example":"no implicit conversion of Symbol into Integer"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/people/bulk_match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/people/bulk_match is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"code":"curl --request POST \\\n --url 'https://api.apollo.io/api/v1/people/bulk_match?reveal_personal_emails=false&reveal_phone_number=false' \\\n --header 'Cache-Control: no-cache' \\\n --header 'Content-Type: application/json' \\\n --header 'accept: application/json' \\\n --data '\n{\n \"details\": [\n {\n \"first_name\": \"tim\",\n \"last_name\": \"zheng\",\n \"name\": \"tim zheng\",\n \"email\": \"tim@apollo.io\",\n \"hashed_email\": \"8d935115b9ff4489f2d1f9249503cadf\",\n \"organization_name\": \"apollo\",\n \"domain\": \"apollo.io\",\n \"id\": \"587cf802f65125cad923a266\",\n \"linkedin_url\": \"http://www.linkedin.com/in/tim-zheng-677ba010\"\n }\n ]\n}\n'","language":"shell","name":""}],"samples-languages":["shell"]}}},"/organizations/enrich":{"get":{"summary":"Organization Enrichment","description":"This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nEnrichment is when you refresh existing records so your prospecting data is up-to-date.

Use the Organization Enrichment endpoint to enrich data for one company. To enrich data for up to ten companies with a single API call, use the Bulk Organization Enrichment endpoint instead.

You can match the company to enrich by domain, LinkedIn URL, name, and/or website. At least one of these is required, and providing more than one improves match accuracy.

Enriched data potentially includes industry information, revenue, employee counts, funding round details, corporate phone numbers, and locations.","tags":["Enrichment"],"operationId":"organization-enrichment","parameters":[{"name":"domain","in":"query","description":"The domain of the company that you want to enrich. Do not include `www.`, the `@` symbol, or similar.

At least one of `domain`, `linkedin_url`, `name`, or `website` is required.

Example: `apollo.io` or `microsoft.com`","required":false,"schema":{"type":"string"}},{"name":"linkedin_url","in":"query","description":"The URL for the company's LinkedIn profile.

At least one of `domain`, `linkedin_url`, `name`, or `website` is required.

Example: `http://www.linkedin.com/company/apolloio`","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The name of the company that you want to enrich.

At least one of `domain`, `linkedin_url`, `name`, or `website` is required.

Example: `apollo`","required":false,"schema":{"type":"string"}},{"name":"website","in":"query","description":"The full website URL of the company that you want to enrich.

At least one of `domain`, `linkedin_url`, `name`, or `website` is required.

Example: `http://www.apollo.io`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 Mission St, Floor 37, San Francisco, California 94105, US","street_address":"415 Mission St","city":"San Francisco","state":"California","postal_code":"94105-2301","country":"United States","owned_by_organization_id":null,"seo_description":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform.","short_description":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„","suborganizations":[],"num_suborganizations":0,"annual_revenue_printed":"100M","annual_revenue":100000000,"total_funding":251200000,"total_funding_printed":"251.2M","latest_funding_round_date":"2023-08-01T00:00:00.000+00:00","latest_funding_stage":"Series D","funding_events":[{"id":"6574c1ff9b797d0001fdab1b","date":"2023-08-01T00:00:00.000+00:00","news_url":null,"type":"Series D","investors":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners","amount":"100M","currency":"$"},{"id":"624f4dfec786590001768016","date":"2022-03-01T00:00:00.000+00:00","news_url":null,"type":"Series C","investors":"Sequoia Capital, Tribe Capital, Nexus Venture Partners, NewView Capital","amount":"110M","currency":"$"},{"id":"61b13677623110000186a478","date":"2021-10-01T00:00:00.000+00:00","news_url":null,"type":"Series B","investors":"Tribe Capital, NewView Capital, Nexus Venture Partners","amount":"32M","currency":"$"},{"id":"5ffe93caa54d75077c59acef","date":"2018-06-26T00:00:00.000+00:00","news_url":"https://techcrunch.com/2018/06/26/yc-grad-zenprospect-rebrands-as-apollo-lands-7-m-series-a/","type":"Series A","investors":"Nexus Venture Partners, Social Capital, Y Combinator","amount":"7M","currency":"$"},{"id":"6574c1ff9b797d0001fdab20","date":"2016-10-01T00:00:00.000+00:00","news_url":null,"type":"Other","investors":"Y Combinator, SV Angel, Social Capital, Nexus Venture Partners","amount":"2.2M","currency":"$"}],"technology_names":["AI","Android","Basis","Canva","Circle","CloudFlare Hosting","Cloudflare DNS","Drift","Gmail","Google Apps","Google Tag Manager","Google Workspace","Gravity Forms","Hubspot","Intercom","Mailchimp Mandrill","Marketo","Microsoft Office 365","Mobile Friendly","Python","Rackspace MailGun","Remote","Render","Reviews","Salesforce","Stripe","Typekit","WP Engine","Wistia","WordPress.org","Yandex Metrica","reCAPTCHA"],"current_technologies":[{"uid":"ai","name":"AI","category":"Other"},{"uid":"android","name":"Android","category":"Frameworks and Programming Languages"},{"uid":"basis","name":"Basis","category":"Advertising Networks"},{"uid":"canva","name":"Canva","category":"Content Management Platform"},{"uid":"circle","name":"Circle","category":"Financial Software"},{"uid":"cloudflare_hosting","name":"CloudFlare Hosting","category":"Hosting"},{"uid":"cloudflare_dns","name":"Cloudflare DNS","category":"Domain Name Services"},{"uid":"drift","name":"Drift","category":"Widgets"},{"uid":"gmail","name":"Gmail","category":"Email Providers"},{"uid":"google_apps","name":"Google Apps","category":"Other"},{"uid":"google_tag_manager","name":"Google Tag Manager","category":"Tag Management"},{"uid":"google workspace","name":"Google Workspace","category":"Cloud Services"},{"uid":"gravity_forms","name":"Gravity Forms","category":"Hosted Forms"},{"uid":"hubspot","name":"Hubspot","category":"Marketing Automation"},{"uid":"intercom","name":"Intercom","category":"Support and Feedback"},{"uid":"mailchimp_mandrill","name":"Mailchimp Mandrill","category":"Email Delivery"},{"uid":"marketo","name":"Marketo","category":"Marketing Automation"},{"uid":"office_365","name":"Microsoft Office 365","category":"Other"},{"uid":"mobile_friendly","name":"Mobile Friendly","category":"Other"},{"uid":"python","name":"Python","category":"Frameworks and Programming Languages"},{"uid":"rackspace_mailgun","name":"Rackspace MailGun","category":"Email Delivery"},{"uid":"remote","name":"Remote","category":"Other"},{"uid":"render","name":"Render","category":"Other"},{"uid":"reviews","name":"Reviews","category":"Customer Reviews"},{"uid":"salesforce","name":"Salesforce","category":"Customer Relationship Management"},{"uid":"stripe","name":"Stripe","category":"Payments"},{"uid":"typekit","name":"Typekit","category":"Fonts"},{"uid":"wp_engine","name":"WP Engine","category":"CMS"},{"uid":"wistia","name":"Wistia","category":"Online Video Platforms"},{"uid":"wordpress_org","name":"WordPress.org","category":"CMS"},{"uid":"yandex_metrika","name":"Yandex Metrica","category":"Analytics and Tracking"},{"uid":"recaptcha","name":"reCAPTCHA","category":"Captcha"}],"org_chart_root_people_ids":["652fc57e2802bf00010c52f8"],"org_chart_sector":"OrgChart::SectorHierarchy::Rules::IT","org_chart_removed":false,"org_chart_show_department_filter":true,"account_id":"63f53afe4ceeca00016bdd37","account":{"id":"63f53afe4ceeca00016bdd37","domain":"apollo.io","name":"Apollo","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"salesforce","original_source":"salesforce","creator_id":null,"owner_id":"60affe7d6e270a00f5db6fe4","created_at":"2023-02-21T21:43:26.351Z","phone":"+1(202) 555-0114","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":{},"modality":"account","source_display_name":"Imported from Salesforce","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null},"departmental_head_count":{"engineering":228,"operations":28,"support":30,"marketing":36,"human_resources":29,"sales":177,"finance":8,"consulting":8,"legal":5,"arts_and_design":27,"accounting":3,"business_development":14,"information_technology":8,"education":6,"media_and_commmunication":3,"product_management":16,"entrepreneurship":3,"data_science":6,"administrative":3},"organization_headcount_six_month_growth":12.3,"organization_headcount_twelve_month_growth":24.6,"organization_headcount_twenty_four_month_growth":48.9}}}},"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"industry":{"type":"string","example":"information technology & services"},"keywords":{"type":"array","items":{"type":"string","example":"sales engagement"}},"estimated_num_employees":{"type":"integer","example":1600,"default":0},"industries":{"type":"array","items":{"type":"string","example":"information technology & services"}},"secondary_industries":{"type":"array"},"snippets_loaded":{"type":"boolean","example":true,"default":true},"industry_tag_id":{"type":"string","example":"5567cd4773696439b10b0000"},"industry_tag_hash":{"type":"object","properties":{"information technology & services":{"type":"string","example":"5567cd4773696439b10b0000"}}},"retail_location_count":{"type":"integer","example":0,"default":0},"raw_address":{"type":"string","example":"415 Mission St, Floor 37, San Francisco, California 94105, US"},"street_address":{"type":"string","example":"415 Mission St"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"California"},"postal_code":{"type":"string","example":"94105-2301"},"country":{"type":"string","example":"United States"},"owned_by_organization_id":{},"seo_description":{"type":"string","example":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform."},"short_description":{"type":"string","example":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„"},"suborganizations":{"type":"array"},"num_suborganizations":{"type":"integer","example":0,"default":0},"annual_revenue_printed":{"type":"string","example":"100M"},"annual_revenue":{"type":"integer","example":100000000,"default":0},"total_funding":{"type":"integer","example":251200000,"default":0},"total_funding_printed":{"type":"string","example":"251.2M"},"latest_funding_round_date":{"type":"string","example":"2023-08-01T00:00:00.000+00:00"},"latest_funding_stage":{"type":"string","example":"Series D"},"funding_events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6574c1ff9b797d0001fdab1b"},"date":{"type":"string","example":"2023-08-01T00:00:00.000+00:00"},"news_url":{},"type":{"type":"string","example":"Series D"},"investors":{"type":"string","example":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners"},"amount":{"type":"string","example":"100M"},"currency":{"type":"string","example":"$"}}}},"technology_names":{"type":"array","items":{"type":"string","example":"AI"}},"current_technologies":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","example":"ai"},"name":{"type":"string","example":"AI"},"category":{"type":"string","example":"Other"}}}},"org_chart_root_people_ids":{"type":"array","items":{"type":"string","example":"652fc57e2802bf00010c52f8"}},"org_chart_sector":{"type":"string","example":"OrgChart::SectorHierarchy::Rules::IT"},"org_chart_removed":{"type":"boolean","example":false,"default":true},"org_chart_show_department_filter":{"type":"boolean","example":true,"default":true},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd37"},"account":{"type":"object","properties":{"id":{"type":"string","example":"63f53afe4ceeca00016bdd37"},"domain":{"type":"string","example":"apollo.io"},"name":{"type":"string","example":"Apollo"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"account_stage_id":{},"source":{"type":"string","example":"salesforce"},"original_source":{"type":"string","example":"salesforce"},"creator_id":{},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"created_at":{"type":"string","example":"2023-02-21T21:43:26.351Z"},"phone":{"type":"string","example":"+1(202) 555-0114"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+12025550114"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array"},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6504905b21ba8e00a334eb0f"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Imported from Salesforce"},"crm_record_url":{},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}},"departmental_head_count":{"type":"object","properties":{"engineering":{"type":"integer","example":228,"default":0},"operations":{"type":"integer","example":28,"default":0},"support":{"type":"integer","example":30,"default":0},"marketing":{"type":"integer","example":36,"default":0},"human_resources":{"type":"integer","example":29,"default":0},"sales":{"type":"integer","example":177,"default":0},"finance":{"type":"integer","example":8,"default":0},"consulting":{"type":"integer","example":8,"default":0},"legal":{"type":"integer","example":5,"default":0},"arts_and_design":{"type":"integer","example":27,"default":0},"accounting":{"type":"integer","example":3,"default":0},"business_development":{"type":"integer","example":14,"default":0},"information_technology":{"type":"integer","example":8,"default":0},"education":{"type":"integer","example":6,"default":0},"media_and_commmunication":{"type":"integer","example":3,"default":0},"product_management":{"type":"integer","example":16,"default":0},"entrepreneurship":{"type":"integer","example":3,"default":0},"data_science":{"type":"integer","example":6,"default":0},"administrative":{"type":"integer","example":3,"default":0}}},"organization_headcount_six_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 6 months. Returns `null` when growth data is not available for the company.","example":12.3},"organization_headcount_twelve_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 12 months. Returns `null` when growth data is not available for the company.","example":24.6},"organization_headcount_twenty_four_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 24 months. Returns `null` when growth data is not available for the company.","example":48.9}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add a company to enrich":{"value":"{\n \"error\": \"Required parameter 'domain' missing\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Required parameter 'domain' missing"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/organizations/enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/organizations/enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/organizations/bulk_enrich":{"post":{"summary":"Bulk Organization Enrichment","description":"This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nEnrichment is when you refresh existing records so your prospecting data is up-to-date.

Use the Bulk Organization Enrichment endpoint to enrich data for up to ten companies with a single API call. To enrich data for a single company, use the Organization Enrichment endpoint instead.

You can identify the companies to enrich by providing a list of domains via the domains[] query parameter, or by providing a details array in the request body where each company can be matched by any combination of domain, LinkedIn URL, name, and website.

Enriched data potentially includes industry information, revenue, employee counts, funding round details, and corporate phone numbers and locations.

This endpoint's rate limit is 20/min, 100/hour, 600/day.","tags":["Enrichment"],"operationId":"bulk-organization-enrichment","parameters":[{"name":"domains[]","in":"query","description":"The domain of each company that you want to enrich. Do not include `www.`, the `@` symbol, or similar.

Use this parameter to match companies by domain only. To match by LinkedIn URL, name, or website in addition to domain, use the `details` array in the request body instead.

This parameter is required unless you provide a `details` payload in the request body.

Example: `apollo.io` and `microsoft.com`","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"details":{"type":"array","description":"Provide info for each company you want to enrich as an object within this array. Add up to 10 companies. Each object can include any combination of `domain`, `linkedin_url`, `name`, and `website`. Providing more than one value for a company improves match accuracy.

If you provide a `details` payload, it takes precedence over the `domains[]` query parameter.","items":{"properties":{"domain":{"type":"string","description":"The domain of the company that you want to enrich. Do not include `www.`, the `@` symbol, or similar.

Example: `apollo.io` or `microsoft.com`"},"linkedin_url":{"type":"string","description":"The URL for the company's LinkedIn profile.

Example: `http://www.linkedin.com/company/apolloio`"},"name":{"type":"string","description":"The name of the company that you want to enrich.

Example: `apollo`"},"website":{"type":"string","description":"The full website URL of the company that you want to enrich.

Example: `http://www.apollo.io`"}},"type":"object"}}}},"examples":{"Match by domain":{"summary":"Match by domain","value":{"details":[{"domain":"apollo.io"},{"domain":"microsoft.com"}]}},"Match by domain, LinkedIn URL, name, or website":{"summary":"Match by domain, LinkedIn URL, name, or website","value":{"details":[{"domain":"apollo.io","linkedin_url":"http://www.linkedin.com/company/apolloio","name":"apollo","website":"http://www.apollo.io"},{"linkedin_url":"http://www.linkedin.com/company/microsoft"},{"name":"google"}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"status":"success","error_code":null,"error_message":null,"total_requested_records":null,"total_requested_domains":4,"unique_domains":4,"unique_records":null,"unique_enriched_records":4,"missing_records":0,"organizations":[{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","industry":"information technology & services","keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data"],"estimated_num_employees":1600,"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"415 mission st, floor 37, san francisco, california 94105, us","street_address":"415 Mission St","city":"San Francisco","state":"California","country":"United States","postal_code":"94105-2301","owned_by_organization_id":null,"seo_description":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform.","short_description":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„","account_id":"63f53afe4ceeca00016bdd37","account":{"id":"63f53afe4ceeca00016bdd37","domain":"apollo.io","name":"Apollo","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"salesforce","original_source":"salesforce","creator_id":null,"owner_id":"60affe7d6e270a00f5db6fe4","created_at":"2023-02-21T21:43:26.351Z","phone":"+1(202) 555-0114","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Imported from Salesforce","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null},"departmental_head_count":{"engineering":228,"operations":28,"support":30,"marketing":36,"human_resources":29,"sales":177,"finance":8,"consulting":8,"legal":5,"arts_and_design":27,"accounting":3,"business_development":14,"information_technology":8,"education":6,"media_and_commmunication":3,"product_management":16,"entrepreneurship":3,"data_science":6,"administrative":3},"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"organization_headcount_six_month_growth":12.3,"organization_headcount_twelve_month_growth":24.6,"organization_headcount_twenty_four_month_growth":48.9},{"id":"62337760d02af100a5ca2468","name":"Microsoft","website_url":"http://www.microsoft.com","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/microsoft","twitter_url":"https://twitter.com/microsoftindia","facebook_url":"https://facebook.com/MicrosoftIndia","primary_phone":{"number":"+1 800-555-0199","source":"Scraped","sanitized_number":"+18005550199"},"languages":["English"],"alexa_ranking":32,"phone":"+1 800-555-0199","linkedin_uid":"1035","founded_year":1975,"publicly_traded_symbol":"MSFT","publicly_traded_exchange":"nasdaq","logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/31940bbec6ef79ed1d50a150/picture","crunchbase_url":null,"primary_domain":"microsoft.com","sanitized_phone":"+18005550199","market_cap":"3100.6B","industry":"information technology & services","keywords":["digital marketing","business software","developer tools","home","educational software","tablets","search","advertising","servers","windows operating system","windows applications","platforms","smartphones","cloud computing","quantum computing","future of work","productivity","ai","artificial intelligence","machine learning","laptops","mixed reality","virtual reality","gaming","developers","it professional","computers","electronics","mobile phones","shopping"],"estimated_num_employees":245000,"industries":["information technology & services","internet"],"secondary_industries":["internet"],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000","internet":"5567cd4d736964397e020000"},"retail_location_count":96,"raw_address":"1 microsoft way, redmond, washington 98052, us","street_address":"1 Microsoft Way","city":"Redmond","state":"Washington","country":"United States","postal_code":"98052","owned_by_organization_id":null,"seo_description":"Sign in to your Outlook.com, Hotmail.com, MSN.com or Live.com account. Download the free desktop and mobile app to connect all your email accounts, including Gmail, Yahoo, and iCloud, in one place.","short_description":"Every company has a mission. What's ours? To empower every person and every organization to achieve more. We believe technology can and should be a force for good and that meaningful innovation contributes to a brighter world in the future and today. Our culture doesn't just encourage curiosity; it embraces it. Each day we make progress together by showing up as our authentic selves. We show up with a learn-it-all mentality. We show up cheering on others, knowing their success doesn't diminish our own. We show up every day open to learning our own biases, changing our behavior, and inviting in differences. Because impact matters. \n\nMicrosoft operates in 190 countries and is made up of approximately 228,000 passionate employees worldwide.","account_id":"6658955677a2f20001c64787","account":{"id":"6658955677a2f20001c64787","domain":"microsoft.com","name":"Microsoft","team_id":"6095a710bd01d100a506d4ac","organization_id":"62337760d02af100a5ca2468","account_stage_id":"6095a710bd01d100a506d4b7","source":"crm","original_source":"crm","creator_id":null,"owner_id":null,"created_at":"2024-05-30T15:03:50.069Z","phone":null,"phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Imported from CRM","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null},"departmental_head_count":{"engineering":41862,"sales":7633,"support":8019,"marketing":3671,"human_resources":2898,"education":13257,"media_and_commmunication":1167,"consulting":2616,"operations":2611,"finance":2335,"product_management":6637,"business_development":5768,"information_technology":2591,"data_science":1732,"arts_and_design":1398,"entrepreneurship":88,"administrative":281,"legal":662,"accounting":169},"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null},{"id":"5fc93db64c38d300d6aa24e6","name":"Google","website_url":"http://www.google.com","blog_url":null,"angellist_url":"http://angel.co/category-five","linkedin_url":"http://www.linkedin.com/company/google","twitter_url":"http://twitter.com/Cat5BoatShoes.com","facebook_url":"https://facebook.com/Google","primary_phone":{"number":"+1 650-555-0129","source":"Owler","sanitized_number":"+16505550129"},"languages":[],"alexa_ranking":9,"phone":"+1 650-555-0129","linkedin_uid":"1441","founded_year":1998,"publicly_traded_symbol":"GOOGL","publicly_traded_exchange":"nasdaq","logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/61d5c2cb5de61cabcb0795b5/picture","crunchbase_url":null,"primary_domain":"google.com","sanitized_phone":"+16505550129","market_cap":"652.3B","industry":"information technology & services","keywords":["e-commerce","fashion","retail","social commerce","consumer internet","internet","information technology","search","ads","mobile","android","online video","apps","machine learning","virtual reality","cloud","hardware","artificial intelligence","youtube","software"],"estimated_num_employees":300000,"industries":["information technology & services","internet","computer software"],"secondary_industries":["internet","computer software"],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000","internet":"5567cd4d736964397e020000","computer software":"5567cd4e7369643b70010000"},"retail_location_count":0,"raw_address":"1600 amphitheatre parkway, mountain view, ca 94043, us","street_address":"1600 Amphitheatre Parkway","city":"Mountain View","state":"California","country":"United States","postal_code":"94043","owned_by_organization_id":"57c4a824a6da98411e7df3eb","owned_by_organization":{"id":"57c4a824a6da98411e7df3eb","name":"Alphabet Inc.","website_url":"http://www.abc.xyz"},"seo_description":"","short_description":"Google is a California-based multinational technology company that offers internet-related services such as a search engine, online advertising and cloud computing.","account_id":"665c3308da53130001240992","account":{"id":"665c3308da53130001240992","domain":"google.com","name":"Google","team_id":"6095a710bd01d100a506d4ac","organization_id":"5fc93db64c38d300d6aa24e6","account_stage_id":"6095a710bd01d100a506d4b7","source":"crm","original_source":"crm","creator_id":null,"owner_id":null,"created_at":"2024-06-02T08:53:28.090Z","phone":null,"phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Imported from CRM","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null},"departmental_head_count":{"engineering":47305,"finance":1664,"marketing":4714,"human_resources":2428,"business_development":4166,"operations":4771,"education":1510,"consulting":2033,"sales":6025,"legal":1075,"information_technology":970,"arts_and_design":1717,"product_management":3743,"administrative":695,"support":778,"media_and_commmunication":1358,"entrepreneurship":135,"data_science":1663,"accounting":280},"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null},{"id":"5da2e6a3f978a8000177e831","name":"Goldman Sachs","website_url":"http://www.goldmansachs.com","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/goldman-sachs","twitter_url":"https://twitter.com/goldmansachs","facebook_url":"https://facebook.com/goldmansachs/","primary_phone":{"number":"+1 212-555-0185","source":"Owler","sanitized_number":"+12125550185"},"languages":["English"],"alexa_ranking":36319,"phone":"+1 212-555-0185","linkedin_uid":"1382","founded_year":1869,"publicly_traded_symbol":"GS","publicly_traded_exchange":"nasdaq","logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/b59fae1dca26f50164e6f897/picture","crunchbase_url":null,"primary_domain":"goldmansachs.com","sanitized_phone":"+12125550185","market_cap":"161.1B","industry":"financial services","keywords":["financial services","finance technology","payments","consumer internet","finance","internet","information technology"],"estimated_num_employees":56000,"industries":["financial services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cdd67369643e64020000","industry_tag_hash":{"financial services":"5567cdd67369643e64020000"},"retail_location_count":0,"raw_address":"200 west street, new york, new york, united states","street_address":"200 West Street","city":"New York","state":"New York","country":"United States","postal_code":"10282","owned_by_organization_id":null,"seo_description":"VyuΕΎijte naΕ‘Γ­ lokΓ‘lnΓ­ expertΓ­zy a vyberte si z Ε‘irokΓ© nabΓ­dky podΓ­lovΓ½ch fondΕ― v českΓ© korunΔ› i cizΓ­ch mΔ›nΓ‘ch.","short_description":"At Goldman Sachs, we believe progress is everyone's business. That's why we commit our people, capital and ideas to help our clients, shareholders and the communities we serve to grow.\nFounded in 1869, Goldman Sachs is a leading global investment banking, securities and investment management firm. Headquartered in New York, we maintain offices in all major financial centers around the world. \n\nMore about our company can be found at www.goldmansachs.com\n\nFor insights on developments currently shaping markets, industries and the global economy, subscribe to BRIEFINGS, a weekly email from Goldman Sachs. Copy and paste this link into your browser to sign up: http://link.gs.com/Qxf3\n\ngs.com/social-media-disclosures","account_id":"6598a1d4d229e900012160ea","account":{"id":"6598a1d4d229e900012160ea","domain":"goldmansachs.com","name":"Goldman Sachs","team_id":"6095a710bd01d100a506d4ac","organization_id":"5da2e6a3f978a8000177e831","account_stage_id":"6095a710bd01d100a506d4b7","source":"deployment","original_source":"deployment","creator_id":"60affe7d6e270a00f5db6fe4","owner_id":null,"created_at":"2024-01-06T00:41:56.898Z","phone":"+18555550155","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+18555550155","account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"664f9ea3d0ff61000146a48d","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"664f9ea3d0ff61000146a48d","key":"664f9ea3d0ff61000146a48d"}],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Requested from Apollo","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null},"departmental_head_count":{"human_resources":577,"engineering":4332,"business_development":667,"arts_and_design":88,"operations":1186,"sales":786,"finance":1816,"product_management":324,"information_technology":249,"marketing":229,"administrative":297,"accounting":109,"legal":500,"data_science":329,"consulting":258,"education":51,"media_and_commmunication":109,"support":173,"entrepreneurship":15},"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null}]}}},"schema":{"type":"object","properties":{"status":{"type":"string","example":"success"},"error_code":{},"error_message":{},"total_requested_records":{"type":"integer","description":"The total number of companies submitted in the `details` payload, including duplicates. Returned only when you enrich using the `details` request body; `null` for `domains[]` requests.","example":4,"default":0},"total_requested_domains":{"type":"integer","description":"The total number of domains submitted via the `domains[]` query parameter, including duplicates. Returned only for `domains[]` requests; `null` when you enrich using the `details` payload.","example":4,"default":0},"unique_domains":{"type":"integer","description":"The number of unique domains submitted via the `domains[]` query parameter. Returned only for `domains[]` requests; `null` when you enrich using the `details` payload.","example":4,"default":0},"unique_records":{"type":"integer","description":"The number of unique companies submitted in the `details` payload after de-duplication. Returned only when you enrich using the `details` request body; `null` for `domains[]` requests.","example":4,"default":0},"unique_enriched_records":{"type":"integer","example":4,"default":0},"missing_records":{"type":"integer","example":0,"default":0},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"industry":{"type":"string","example":"information technology & services"},"keywords":{"type":"array","items":{"type":"string","example":"sales engagement"}},"estimated_num_employees":{"type":"integer","example":1600,"default":0},"industries":{"type":"array","items":{"type":"string","example":"information technology & services"}},"secondary_industries":{"type":"array"},"snippets_loaded":{"type":"boolean","example":true,"default":true},"industry_tag_id":{"type":"string","example":"5567cd4773696439b10b0000"},"industry_tag_hash":{"type":"object","properties":{"information technology & services":{"type":"string","example":"5567cd4773696439b10b0000"}}},"retail_location_count":{"type":"integer","example":0,"default":0},"raw_address":{"type":"string","example":"415 mission st, floor 37, san francisco, california 94105, us"},"street_address":{"type":"string","example":"415 Mission St"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"California"},"country":{"type":"string","example":"United States"},"postal_code":{"type":"string","example":"94105-2301"},"owned_by_organization_id":{},"seo_description":{"type":"string","example":"Search, engage, and convert over 275 million contacts at over 73 million companies with Apollo's sales intelligence and engagement platform."},"short_description":{"type":"string","example":"Apollo.io combines a buyer database of over 270M contacts and powerful sales engagement and automation tools in one, easy to use platform. Trusted by over 160,000 companies including Autodesk, Rippling, Deel, Jasper.ai, Divvy, and Heap, Apollo has more than one million users globally. By helping sales professionals find their ideal buyers and intelligently automate outreach, Apollo helps go-to-market teams sell anything.\n\nCelebrating a $100M Series D Funding Round πŸ¦„"},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd37"},"account":{"type":"object","properties":{"id":{"type":"string","example":"63f53afe4ceeca00016bdd37"},"domain":{"type":"string","example":"apollo.io"},"name":{"type":"string","example":"Apollo"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"account_stage_id":{},"source":{"type":"string","example":"salesforce"},"original_source":{"type":"string","example":"salesforce"},"creator_id":{},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"created_at":{"type":"string","example":"2023-02-21T21:43:26.351Z"},"phone":{"type":"string","example":"+1(202) 555-0114"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+12025550114"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array"},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6504905b21ba8e00a334eb0f"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Imported from Salesforce"},"crm_record_url":{},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}},"departmental_head_count":{"type":"object","properties":{"engineering":{"type":"integer","example":228,"default":0},"operations":{"type":"integer","example":28,"default":0},"support":{"type":"integer","example":30,"default":0},"marketing":{"type":"integer","example":36,"default":0},"human_resources":{"type":"integer","example":29,"default":0},"sales":{"type":"integer","example":177,"default":0},"finance":{"type":"integer","example":8,"default":0},"consulting":{"type":"integer","example":8,"default":0},"legal":{"type":"integer","example":5,"default":0},"arts_and_design":{"type":"integer","example":27,"default":0},"accounting":{"type":"integer","example":3,"default":0},"business_development":{"type":"integer","example":14,"default":0},"information_technology":{"type":"integer","example":8,"default":0},"education":{"type":"integer","example":6,"default":0},"media_and_commmunication":{"type":"integer","example":3,"default":0},"product_management":{"type":"integer","example":16,"default":0},"entrepreneurship":{"type":"integer","example":3,"default":0},"data_science":{"type":"integer","example":6,"default":0},"administrative":{"type":"integer","example":3,"default":0}}},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{},"organization_headcount_six_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 6 months. Returns `null` when growth data is not available for the company.","example":12.3},"organization_headcount_twelve_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 12 months. Returns `null` when growth data is not available for the company.","example":24.6},"organization_headcount_twenty_four_month_growth":{"type":"number","description":"The percentage change in the company's total headcount over the previous 24 months. Returns `null` when growth data is not available for the company.","example":48.9}}}}}}}}},"400":{"description":"400","content":{"text/plain":{"examples":{"Add domains":{"value":"{\n \"status\": \"failed\",\n \"error_code\": \"INVALID_REQUEST\",\n \"error_message\": \"invalid request, missing domains\"\n}"}},"schema":{"type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"INVALID_REQUEST"},"error_message":{"type":"string","example":"invalid request, missing domains"}}}},"application/json":{"examples":{"More than 10 companies":{"value":"{\n \"status\": \"failed\",\n \"error_code\": \"RECORD_LIMIT_EXCEEDED\",\n \"error_message\": \"domain count cannot be more than 10\"\n}"}},"schema":{"type":"object","properties":{"status":{"type":"string","example":"failed"},"error_code":{"type":"string","example":"RECORD_LIMIT_EXCEEDED"},"error_message":{"type":"string","example":"domain count cannot be more than 10"}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/organizations/bulk_enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/organizations/bulk_enrich is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/mixed_people/api_search":{"post":{"summary":"People API Search","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nPeople are net-new prospects you haven't yet saved as contacts on Apollo.

Use the People API Search endpoint to find new prospects. Several filters are available to help narrow your search. This endpoint doesn't return email addresses or phone numbers. Use the People Enrichment or Bulk People Enrichment endpoints to enrich data.

This endpoint requires a master API key. Check out Create an API Key to learn how to create a master key.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.","tags":["Search"],"operationId":"people-api-search","parameters":[{"name":"person_titles[]","in":"query","description":"Job titles held by the people you want to find. For a person to be included in search results, they only need to match 1 of the job titles you add. Adding more job titles expands your search results.

Results also include job titles with the same terms, even if they are not exact matches. For example, searching for `marketing manager` might return people with the job title `content marketing manager`.

Use this parameter in combination with the `person_seniorities[]` parameter to find people based on specific job functions and seniority levels.

Examples: `sales development representative`; `marketing manager`; `research analyst`","schema":{"type":"array","items":{"type":"string"}}},{"name":"include_similar_titles","in":"query","required":false,"description":"This parameter determines whether people with job titles similar to the titles you define in the `person_titles[]` parameter are returned in the response.

Set this parameter to `false` when using `person_titles[]` to return only strict matches for job titles.","schema":{"type":"boolean","example":"true","default":""}},{"name":"q_keywords","in":"query","required":false,"description":"A string of words over which we want to filter the results.","schema":{"type":"string","default":""}},{"name":"person_locations[]","in":"query","description":"The location where people live. You can search across cities, US states, and countries.

To find people based on the headquarters locations of their current employer, use the `organization_locations` parameter.

Examples: `california`; `ireland`; `chicago`","schema":{"type":"array","items":{"type":"string"}}},{"name":"person_seniorities[]","in":"query","required":false,"description":"The job seniority that people hold within their current employer. This enables you to find people that currently hold positions at certain reporting levels, such as Director level or senior IC level.

For a person to be included in search results, they only need to match 1 of the seniorities you add. Adding more seniorities expands your search results.

Searches only return results based on their current job title, so searching for Director-level employees only returns people that currently hold a Director-level title. If someone was previously a Director, but is currently a VP, they would not be included in your search results.

Use this parameter in combination with the `person_titles[]` parameter to find people based on specific job functions and seniority levels.

The following options can be used for this parameter:
","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_locations[]","in":"query","description":"The location of the company headquarters for a person's current employer. You can search across cities, US states, and countries.

If a company has several office locations, results are still based on the headquarters location. For example, if you search `chicago` but a company's HQ location is in `boston`, people that work for the Boston-based company will not appear in your results, even if they match other \\parameters.

To find people based on their personal location, use the `person_locations` parameter.

Examples: `texas`; `tokyo`; `spain`","schema":{"type":"array","items":{"type":"string"}}},{"name":"q_organization_domains_list[]","in":"query","required":false,"description":"The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar.

This parameter accepts up to 1,000 domains in a single request.

Examples: `apollo.io`; `microsoft.com`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"contact_email_status[]","in":"query","description":"The email statuses for the people you want to find. You can add multiple statuses to expand your search.

The statuses you can search include: ","schema":{"type":"array","items":{"type":"string"}}},{"name":"organization_ids[]","in":"query","description":"The Apollo IDs for the companies (employers) you want to include in your search results. Each company in the Apollo database is assigned a unique ID.

To find IDs, call the Organization Search endpoint and identify the values for `organization_id`.

Example: `5e66b6381e05b4008c8331b8`","schema":{"type":"array","items":{"type":"string"}}},{"name":"organization_num_employees_ranges[]","in":"query","description":"The number range of employees working for the person's current company. This enables you to find people based on the headcount of their employer. You can add multiple ranges to expand your search results.

Each range you add needs to be a string, with the upper and lower numbers of the range separated only by a comma.

Examples: `1,10`; `250,500`; `10000,20000`","schema":{"type":"array","items":{"type":"string"}}},{"name":"revenue_range[min]","in":"query","required":false,"description":"The minimum revenue the person's current employer generates. Use this parameter in combination with `revenue_range[max]` to set a revenue range.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `500000`; `1500000`","schema":{"type":"integer","default":""}},{"name":"revenue_range[max]","in":"query","required":false,"description":"The maximum revenue the person's current employer generates. Use this parameter in combination with `revenue_range[min]` to set a revenue range.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `500000`; `1500000`","schema":{"type":"integer","default":""}},{"name":"currently_using_all_of_technology_uids[]","in":"query","required":false,"description":"Find people based on all of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies.

Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by downloading this CSV file.

Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file.

Examples: `salesforce`; `google_analytics`; `wordpress_org`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"currently_using_any_of_technology_uids[]","in":"query","required":false,"description":"Find people based on any of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies.

Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by downloading this CSV file.

Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file.

Examples: `salesforce`; `google_analytics`; `wordpress_org`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"currently_not_using_any_of_technology_uids[]","in":"query","required":false,"description":"Exclude people from your search based on any of the technologies their current employer uses. Apollo supports filtering by 1,500+ technologies.

Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by downloading this CSV file.

Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file.

Examples: `salesforce`; `google_analytics`; `wordpress_org`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"q_organization_job_titles[]","in":"query","required":false,"description":"The job titles that are listed in active job postings at the person's current employer.

Examples: `sales manager`; `research analyst`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_job_locations[]","in":"query","required":false,"description":"The locations of the jobs being actively recruited by the person's employer.

Examples: `atlanta`; `japan`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_num_jobs_range[min]","in":"query","required":false,"description":"The minimum number of job postings active at the person's current empployer. Use this parameter in combination with `organization_num_jobs_range[max]` to set a job postings range.

Examples: `50`; `500`","schema":{"type":"integer","default":""}},{"name":"organization_num_jobs_range[max]","in":"query","required":false,"description":"The maximum number of job postings active at the person's current empployer. Use this parameter in combination with `organization_num_jobs_range[min]` to set a job postings range.

Examples: `50`; `500`","schema":{"type":"integer","default":""}},{"name":"organization_job_posted_at_range[min]","in":"query","required":false,"description":"The earliest date when jobs were posted by the person's current employer. Use this parameter in combination with `organization_job_posted_at_range[max]` to set a date range for when jobs posted.

Example: `2025-07-25`","schema":{"type":"string","format":"date","default":""}},{"name":"organization_job_posted_at_range[max]","in":"query","required":false,"description":"The latest date when jobs were posted by the person's current employer. Use this parameter in combination with `organization_job_posted_at_range[min]` to set a date range for when jobs posted.

Example: `2025-09-25`","schema":{"type":"string","format":"date","default":""}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","required":false,"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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32","default":""}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"total_entries":232764882,"people":[{"id":"67bdafd0c3a4c50001bbd7c2","first_name":"Andrew","last_name_obfuscated":"Hu***n","title":"Professor and Neuroscientist at Stanford & Host","last_refreshed_at":"2025-11-04T23:20:32.690+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Scicomm Media","has_industry":true,"has_phone":false,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":false,"has_revenue":false,"has_employee_count":true}},{"id":"6775057df8360a0001a6852c","first_name":"Jon","last_name_obfuscated":"St***g","title":"Managing Director","last_refreshed_at":"2025-11-05T15:56:08.901+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Lazard","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":true,"has_revenue":true,"has_employee_count":true}},{"id":"637dd5071c576c0001ccbff4","first_name":"Lorena","last_name_obfuscated":"Ac***a","title":"Director of Operations","last_refreshed_at":"2025-11-03T10:01:50.493+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Be Busy Being Awesome","has_industry":true,"has_phone":false,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":false,"has_revenue":false,"has_employee_count":true}},{"id":"6282fecea784280001553642","first_name":"Linda","last_name_obfuscated":"Ch***n","title":"Sales Manager","last_refreshed_at":"2025-09-29T11:53:35.791+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"MCU Technology Co., Ltd","has_industry":true,"has_phone":true,"has_city":false,"has_state":false,"has_country":false,"has_zip_code":false,"has_revenue":false,"has_employee_count":true}},{"id":"66ed23831ae8c9000186c75b","first_name":"Nicholas","last_name_obfuscated":"Th***n","title":"Chief Executive Officer","last_refreshed_at":"2025-11-07T17:08:51.086+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"The Atlantic","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":true,"has_revenue":true,"has_employee_count":true}},{"id":"6728af09afa3de00011a722e","first_name":"Ron","last_name_obfuscated":"Kr***i","title":null,"last_refreshed_at":"2025-11-05T23:23:13.047+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Stifel Financial Corp.","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":true,"has_revenue":true,"has_employee_count":true}},{"id":"54a2b92a74686935beffa837","first_name":"Rita","last_name_obfuscated":"Ki***g","title":"Founder","last_refreshed_at":"2025-11-07T07:13:05.197+00:00","has_email":true,"has_city":false,"has_state":false,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Power Pairs","has_industry":true,"has_phone":false,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":false,"has_revenue":false,"has_employee_count":true}},{"id":"63be196afa109b000139ace7","first_name":"Austin","last_name_obfuscated":"Be***k","title":"Founder","last_refreshed_at":"2025-11-02T05:22:18.569+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Cultivated Culture","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":false,"has_revenue":false,"has_employee_count":true}},{"id":"5e8a7a4dfd23700001a64dfb","first_name":"Elina","last_name_obfuscated":"Ga***a","title":"SVP, Head of Global Operations","last_refreshed_at":"2025-11-05T13:50:24.941+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Twelve","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":true,"has_revenue":true,"has_employee_count":true}},{"id":"66ec0684cd386c0001b15096","first_name":"Matt","last_name_obfuscated":"Gr***y","title":"Founder & CEO","last_refreshed_at":"2025-11-06T15:08:56.795+00:00","has_email":true,"has_city":true,"has_state":true,"has_country":true,"has_direct_phone":"Yes","organization":{"name":"Founder OS","has_industry":true,"has_phone":true,"has_city":true,"has_state":true,"has_country":true,"has_zip_code":true,"has_revenue":false,"has_employee_count":true}}]}}},"schema":{"type":"object","properties":{"total_entries":{"type":"integer","description":"The total number of people that match your search criteria.","example":2},"people":{"type":"array","description":"An array of people that match your search criteria.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Apollo ID for the person.","example":"587cf802f65125cad923a266"},"first_name":{"type":"string","description":"The first name of the person.","example":"John"},"last_name_obfuscated":{"type":"string","description":"The last name of the person with the middle characters obfuscated for privacy. The format shows the first 2 characters, followed by asterisks, and then the last character.","example":"Do***e"},"title":{"type":["string","null"],"description":"The job title of the person. This field may be null if the person's title is not available.","example":"VP of Sales"},"last_refreshed_at":{"type":"string","format":"date-time","description":"The date and time when the person's data was last refreshed in Apollo's database.","example":"2024-01-15T10:30:00.000Z"},"has_email":{"type":"boolean","description":"Indicates whether Apollo has a verified email address for this person.","example":true},"has_city":{"type":"boolean","description":"Indicates whether Apollo has city location data for this person.","example":true},"has_state":{"type":"boolean","description":"Indicates whether Apollo has state location data for this person.","example":true},"has_country":{"type":"boolean","description":"Indicates whether Apollo has country location data for this person.","example":true},"has_direct_phone":{"type":"string","description":"Indicates whether Apollo has direct phone number data for this person. Returns `Yes` if available, or `Maybe: please request direct dial via people/bulk_match` if uncertain.","example":"Yes"},"organization":{"type":"object","description":"Information about the person's current employer organization.","properties":{"name":{"type":"string","description":"The name of the organization.","example":"Apollo.io"},"has_industry":{"type":"boolean","description":"Indicates whether Apollo has industry classification data for this organization.","example":true},"has_phone":{"type":"boolean","description":"Indicates whether Apollo has phone number data for this organization.","example":true},"has_city":{"type":"boolean","description":"Indicates whether Apollo has city location data for the organization's headquarters.","example":true},"has_state":{"type":"boolean","description":"Indicates whether Apollo has state location data for the organization's headquarters.","example":true},"has_country":{"type":"boolean","description":"Indicates whether Apollo has country location data for the organization's headquarters.","example":true},"has_zip_code":{"type":"boolean","description":"Indicates whether Apollo has postal/zip code data for the organization's headquarters.","example":true},"has_revenue":{"type":"boolean","description":"Indicates whether Apollo has revenue data for this organization.","example":true},"has_employee_count":{"type":"boolean","description":"Indicates whether Apollo has employee count data for this organization.","example":true}}}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":{"error":"api/v1/mixed_people/api_search is not accessible with this api_key","error_code":"API_INACCESSIBLE"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/mixed_people/api_search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Validation error":{"value":{"error":"Invalid parameters"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid search parameters provided."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"message":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/mixed_people/api_search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/mixed_people/api_search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/mixed_companies/search":{"post":{"summary":"Organization Search","description":"This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nOrganizations are companies you haven't yet saved as accounts on Apollo.

Use the Organization Search endpoint to find companies in the Apollo database. Several filters are available to help narrow your search.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.","tags":["Search"],"operationId":"organization-search","parameters":[{"name":"q_organization_domains_list[]","in":"query","required":false,"description":"The domain name for the person's employer. This can be the current employer or a previous employer. Do not include `www.`, the `@` symbol, or similar.

This parameter accepts up to 1,000 domains in a single request.

Examples: `apollo.io`; `microsoft.com`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_num_employees_ranges[]","in":"query","description":"The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results.

Each range you add needs to be a string, with the upper and lower numbers of the range separated only by a comma.

Examples: `1,10`; `250,500`; `10000,20000`","schema":{"type":"array","items":{"type":"string"}}},{"name":"organization_locations[]","in":"query","description":"The location of the company headquarters. You can search across cities, US states, and countries.

If a company has several office locations, results are still based on the headquarters location. For example, if you search `chicago` but a company's HQ location is in `boston`, any Boston-based companies will not appearch in your search results, even if they match other parameters..

To exclude companies based on location, use the `organization_not_locations` parameter.

Examples: `texas`; `tokyo`; `spain`","schema":{"type":"array","items":{"type":"string"}}},{"name":"organization_not_locations[]","in":"query","description":"Exclude companies from search results based on the location of the company headquarters. You can use cities, US states, and countries as locations to exclude.

This parameter is useful for ensuring you do not prospect in an undesirable territory. For example, if you use `ireland` as a value, no Ireland-based companies will appear in your search results.

Examples: `minnesota`; `ireland`; `seoul`","schema":{"type":"array","items":{"type":"string"}}},{"name":"revenue_range[min]","in":"query","description":"Search for organizations based on their revenue.

Use this parameter to set the lower range of organization revenue. Use the `revenue_range[max]` parameter to set the upper range of revenue.

Do not enter currency symbols, commas, or decimal points in the figure.

Example: `300000`","schema":{"type":"integer"}},{"name":"revenue_range[max]","in":"query","description":"Search for organizations based on their revenue.

Use this parameter to set the upper range of organization revenue. Use the `revenue_range[min]` parameter to set the lower range of revenue.

Do not enter currency symbols, commas, or decimal points in the figure.

Example: `50000000`","schema":{"type":"integer"}},{"name":"currently_using_any_of_technology_uids[]","in":"query","description":"Find organizations based on the technologies they currently use. Apollo supports filtering by 1,500+ technologies.

Apollo calculates technologies data from multiple sources. This data is updated regularly. Check out the full list of supported technologies by downloading this CSV file.

Use underscores (`_`) to replace spaces and periods for the technologies listed in the CSV file.

Examples: `salesforce`; `google_analytics`; `wordpress_org`","schema":{"type":"array","items":{"type":"string"}}},{"name":"q_organization_keyword_tags[]","in":"query","description":"Filter search results based on keywords associated with companies. For example, you can enter `mining` as a value to return only companies that have an association with the mining industry.

Examples: `mining`; `sales strategy`; `consulting`","schema":{"type":"array","items":{"type":"string"}}},{"name":"q_organization_name","in":"query","description":"Filter search results to include a specific company name.

If the value you enter for this parameter does not match with a company's name, the company will not appear in search results, even if it matches other parameters. Partial matches are accepted. For example, if you filter by the value `marketing`, a company called `NY Marketing Unlimited` would still be eligible as a search result, but `NY Market Analysis` would not be eligible.

Example: `apollo` or `mining`","schema":{"type":"string"}},{"name":"organization_ids[]","in":"query","description":"The Apollo IDs for the companies you want to include in your search results. Each company in the Apollo database is assigned a unique ID.

To find IDs, identify the values for `organization_id` when you call this endpoint.

Example: `5e66b6381e05b4008c8331b8`","schema":{"type":"array","items":{"type":"string"}}},{"name":"latest_funding_amount_range[min]","in":"query","required":false,"description":"The minimum amount the company received with its most recent funding round. Use this parameter in combination with `latest_funding_amount_range[max]` to set a monetary range for the company's most recent funding round.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `5000000`; `15000000`","schema":{"type":"integer","default":""}},{"name":"latest_funding_amount_range[max]","in":"query","required":false,"description":"The maximium amount the company received with its most recent funding round. Use this parameter in combination with `latest_funding_amount_range[min]` to set a monetary range for the company's most recent funding round.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `5000000`; `15000000`","schema":{"type":"integer","default":""}},{"name":"total_funding_range[min]","in":"query","required":false,"description":"The minimum amount the company received during all of its funding rounds combined. Use this parameter in combination with `total_funding_range[max]` to set a monetary range for all of the company's funding rounds.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `50000000`; `350000000`","schema":{"type":"integer","default":""}},{"name":"total_funding_range[max]","in":"query","required":false,"description":"The maximum amount the company received during all of its funding rounds combined. Use this parameter in combination with `total_funding_range[min]` to set a monetary range for all of the company's funding rounds.

Do not enter currency symbols, commas, or decimal points in the figure.

Examples: `50000000`; `350000000`","schema":{"type":"integer","default":""}},{"name":"latest_funding_date_range[min]","in":"query","required":false,"description":"The earliest date when the company received its most recent funding round. Use this parameter in combination with `latest_funding_date_range[max]` to set a date range for when the company received its most recent funding round.

Example: `2025-07-25`","schema":{"type":"string","format":"date","default":""}},{"name":"latest_funding_date_range[max]","in":"query","required":false,"description":"The latest date when the company received its most recent funding round. Use this parameter in combination with `latest_funding_date_range[min]` to set a date range for when the company received its most recent funding round.

Example: `2025-09-25`","schema":{"type":"string","format":"date","default":""}},{"name":"q_organization_job_titles[]","in":"query","required":false,"description":"The job titles that are listed in active job postings at the company.

Examples: `sales manager`; `research analyst`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_job_locations[]","in":"query","required":false,"description":"The locations of the jobs being actively recruited by the company.

Examples: `atlanta`; `japan`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"organization_num_jobs_range[min]","in":"query","required":false,"description":"The minimum number of job postings active at the company. Use this parameter in combination with `organization_num_jobs_range[max]` to set a job postings range.

Examples: `50`; `500`","schema":{"type":"integer","default":""}},{"name":"organization_num_jobs_range[max]","in":"query","required":false,"description":"The maximum number of job postings active at the company. Use this parameter in combination with `organization_num_jobs_range[min]` to set a job postings range.

Examples: `50`; `500`","schema":{"type":"integer","default":""}},{"name":"organization_job_posted_at_range[min]","in":"query","required":false,"description":"The earliest date when jobs were posted by the company. Use this parameter in combination with `organization_job_posted_at_range[max]` to set a date range for when jobs posted.

Example: `2025-07-25`","schema":{"type":"string","format":"date","default":""}},{"name":"organization_job_posted_at_range[max]","in":"query","required":false,"description":"The latest date when jobs were posted by the company. Use this parameter in combination with `organization_job_posted_at_range[min]` to set a date range for when jobs posted.

Example: `2025-09-25`","schema":{"type":"string","format":"date","default":""}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"breadcrumbs":[{"label":"# Employees","signal_field_name":"organization_num_employees_ranges","value":"250,1000","display_name":"250-1000"},{"label":"# Employees","signal_field_name":"organization_num_employees_ranges","value":"5000,10000","display_name":"5000-10000"},{"label":"Company Locations","signal_field_name":"organization_locations","value":"japan","display_name":"japan"},{"label":"Company Locations","signal_field_name":"organization_locations","value":"ireland","display_name":"ireland"}],"partial_results_only":false,"has_join":false,"disable_eu_prospecting":false,"partial_results_limit":10000,"pagination":{"page":1,"per_page":2,"total_entries":1184,"total_pages":592},"accounts":[],"organizations":[{"id":"615d029256de500001bdb460","name":"Nikkei Asia","website_url":"http://www.nikkei.com","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/nikkeiasia","twitter_url":"https://twitter.com/nikkei","facebook_url":"https://facebook.com/nikkei","primary_phone":{"number":"+81 576-95-0781","source":"Scraped","sanitized_number":"+81576950781"},"languages":["Japanese","Chinese"],"alexa_ranking":1583,"phone":"+81 576-95-0781","linkedin_uid":"3335963","founded_year":1876,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/ff63c201695aca418dd88bd9/picture","crunchbase_url":null,"primary_domain":"nikkei.com","sanitized_phone":"+81576950781","owned_by_organization_id":null,"intent_strength":null,"show_intent":true,"has_intent_signal_account":false,"intent_signal_account":null},{"id":"55f1fcddf3e5bb0be2000a92","name":"Mitsui & Co., Ltd.","website_url":"http://www.mitsui.com","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/mitsui-co-ltd-","twitter_url":"https://twitter.com/citra_citrasa","facebook_url":"https://facebook.com/mitsuiandco/","primary_phone":{"number":"+81 4658-8-1655","source":"Owler","sanitized_number":"+81465881655"},"languages":[],"alexa_ranking":265731,"phone":"+81 4658-8-1655","linkedin_uid":"6675","founded_year":1947,"publicly_traded_symbol":"8031","publicly_traded_exchange":"tyo","logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/4c0885d217ca85624ac6b821/picture","crunchbase_url":null,"primary_domain":"mitsui.com","sanitized_phone":"+81465881655","owned_by_organization_id":null,"intent_strength":null,"show_intent":true,"has_intent_signal_account":false,"intent_signal_account":null}],"model_ids":["615d029256de500001bdb460","55f1fcddf3e5bb0be2000a92"],"num_fetch_result":null,"derived_params":null}}},"schema":{"type":"object","properties":{"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","example":"# Employees"},"signal_field_name":{"type":"string","example":"organization_num_employees_ranges"},"value":{"type":"string","example":"250,1000"},"display_name":{"type":"string","example":"250-1000"}}}},"partial_results_only":{"type":"boolean","example":false,"default":true},"has_join":{"type":"boolean","example":false,"default":true},"disable_eu_prospecting":{"type":"boolean","example":false,"default":true},"partial_results_limit":{"type":"integer","example":10000,"default":0},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":2,"default":0},"total_entries":{"type":"integer","example":1184,"default":0},"total_pages":{"type":"integer","example":592,"default":0}}},"accounts":{"type":"array"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"615d029256de500001bdb460"},"name":{"type":"string","example":"Nikkei Asia"},"website_url":{"type":"string","example":"http://www.nikkei.com"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/nikkeiasia"},"twitter_url":{"type":"string","example":"https://twitter.com/nikkei"},"facebook_url":{"type":"string","example":"https://facebook.com/nikkei"},"primary_phone":{"type":"object","properties":{"number":{"type":"string","example":"+81 576-95-0781"},"source":{"type":"string","example":"Scraped"},"sanitized_number":{"type":"string","example":"+81576950781"}}},"languages":{"type":"array","items":{"type":"string","example":"Japanese"}},"alexa_ranking":{"type":"integer","example":1583,"default":0},"phone":{"type":"string","example":"+81 576-95-0781"},"linkedin_uid":{"type":"string","example":"3335963"},"founded_year":{"type":"integer","example":1876,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/ff63c201695aca418dd88bd9/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"nikkei.com"},"sanitized_phone":{"type":"string","example":"+81576950781"},"owned_by_organization_id":{},"intent_strength":{},"show_intent":{"type":"boolean","example":true,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}}},"model_ids":{"type":"array","items":{"type":"string","example":"615d029256de500001bdb460"}},"num_fetch_result":{},"derived_params":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/mixed_companies/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/mixed_companies/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/organizations/{organization_id}/job_postings":{"get":{"summary":"Organization Job Postings","description":"This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nOrganizations are companies you haven't yet saved as accounts on Apollo.

Use the Organization Job Postings endpoint to retrieve the current job postings for companies. This can help you identify companies that are growing headcount in areas that are strategically important for you.

To protect Apollo's performance for all users, this endpoint has a display limit of 10,000 records.","tags":["Search"],"operationId":"organization-jobs-postings","parameters":[{"name":"organization_id","in":"path","description":"The organization ID of the company for which you want to find job postings.

Each company in the Apollo database is assigned a unique ID. To find IDs, call the Organization Search endpoint and identify the values for `organization_id`.

Example: `5e66b6381e05b4008c8331b8`","schema":{"type":"string"},"required":true},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"organization_job_postings":[{"id":"66d1d4de8a2af7000192f5ec","title":"IT Support Analyst - L2","url":"https://ca.linkedin.com/jobs/view/it-support-analyst-l2-at-apollo-io-4011156187?position=7&pageNum=37&refId=tsq2hhSGkQqjDhp%2BYvKs1g%3D%3D&trackingId=WX5iTs9UYaOlo4NpHFuXZw%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"Canada","last_seen_at":"2024-08-30T14:19:10.200+00:00","posted_at":"2024-08-29T19:19:10.200+00:00"},{"id":"66e02f44a4577d0001edaaa4","title":"Vice President of Customer Support","url":"https://www.linkedin.com/jobs/view/vice-president-of-customer-support-at-apollo-io-4003918877?position=10&pageNum=0&refId=%2F6tCIAG%2BQcE8X0Sg5X9WZg%3D%3D&trackingId=gDhVPelP5eNCS79i4t6rew%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-09-10T11:36:36.635+00:00","posted_at":"2024-09-10T05:36:36.635+00:00"},{"id":"66a28b0764c42e0001cfd6f3","title":"VP, Data","url":"https://www.linkedin.com/jobs/view/vp-data-at-apollo-io-3984634031?position=8&pageNum=20&refId=vodGDy7KpnHiqAYxGtWA7w%3D%3D&trackingId=LIwXOp3hU8JDG2MReniLsQ%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-07-25T17:27:35.583+00:00","posted_at":"2024-07-25T16:51:35.582+00:00"},{"id":"66c7744c79457200017c451e","title":"Vice President, Customer Support","url":"https://www.linkedin.com/jobs/view/vice-president-customer-support-at-apollo-io-4004726038?position=7&pageNum=5&refId=UA3cDmi4LhysaeQVjpP5%2Bw%3D%3D&trackingId=HmEhmlJvSTdVkynujcntVg%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-08-22T17:24:28.536+00:00","posted_at":"2024-08-22T00:24:28.536+00:00"},{"id":"66d845e6e308ad0001326d71","title":"Director, Product - Data","url":"https://www.linkedin.com/jobs/view/director-product-data-at-apollo-io-4015745864?position=7&pageNum=92&refId=ni6xc%2BalODyO6Vw1QtjOQQ%3D%3D&trackingId=77P8dEeOnMTVWYDYOx5Qcg%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-09-04T11:35:02.382+00:00","posted_at":"2024-09-04T11:35:02.382+00:00"},{"id":"66d0723698240a00013100b3","title":"IT Operations Project Lead/IT Business Analyst","url":"https://ca.linkedin.com/jobs/view/it-operations-project-lead-it-business-analyst-at-apollo-io-4009782788?position=2&pageNum=70&refId=q9bjxXDiO9PNQ5yvQ3teig%3D%3D&trackingId=JkvKtlWxbOEKfaKKa%2FyaIA%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"Canada","last_seen_at":"2024-08-29T13:05:57.932+00:00","posted_at":"2024-08-28T18:05:57.932+00:00"},{"id":"66c5cbb028d84c0001f74b9b","title":"Social Media Manager (Contract)","url":"https://www.linkedin.com/jobs/view/social-media-manager-contract-at-apollo-io-4003602892?position=7&pageNum=7&refId=M%2Bq21dX1lE3JzDnEzPC72Q%3D%3D&trackingId=bKhIuXmd2PJWlhJ9m2PEEg%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-08-21T11:12:47.964+00:00","posted_at":"2024-08-21T01:12:47.964+00:00"},{"id":"66c6328347daa90001c5f189","title":"Prompt Writer - Contract","url":"https://www.linkedin.com/jobs/view/prompt-writer-contract-at-apollo-io-4004367531?position=8&pageNum=45&refId=%2FrQ6GY1Gv9DZ1fmX%2F75Bfw%3D%3D&trackingId=SGpayNSVHzAl8Vdtp%2B8mfg%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-08-21T18:31:31.572+00:00","posted_at":"2024-08-21T17:55:31.572+00:00"},{"id":"66d89fa8a268120001c83b11","title":"Customer Success Manager, SMB","url":"https://www.linkedin.com/jobs/view/customer-success-manager-smb-at-apollo-io-4016189459?position=1&pageNum=12&refId=zFeMmz2ca3HvhAoq6gNYYQ%3D%3D&trackingId=jbk1AW24SjSqUfzkMpUNkA%3D%3D&trk=public_jobs_jserp-result_search-card","city":null,"state":null,"country":"United States","last_seen_at":"2024-09-04T17:58:00.682+00:00","posted_at":"2024-09-04T00:58:00.682+00:00"}]}}},"schema":{"type":"object","properties":{"organization_job_postings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66d1d4de8a2af7000192f5ec"},"title":{"type":"string","example":"IT Support Analyst - L2"},"url":{"type":"string","example":"https://ca.linkedin.com/jobs/view/it-support-analyst-l2-at-apollo-io-4011156187?position=7&pageNum=37&refId=tsq2hhSGkQqjDhp%2BYvKs1g%3D%3D&trackingId=WX5iTs9UYaOlo4NpHFuXZw%3D%3D&trk=public_jobs_jserp-result_search-card"},"city":{},"state":{},"country":{"type":"string","example":"Canada"},"last_seen_at":{"type":"string","example":"2024-08-30T14:19:10.200+00:00"},"posted_at":{"type":"string","example":"2024-08-29T19:19:10.200+00:00"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add an organization ID":{"value":"{\n \"error\": \"Parameters misconfigured. organization_id is not a valid ID\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. organization_id is not a valid ID"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/organizations/{organization_id}/job_postings is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/organizations/{organization_id}/job_postings is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/accounts":{"post":{"summary":"Create an Account","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAn account is a company saved in Apollo.

Use the Create an Account endpoint to add a new account to your team's Apollo account.

Apollo doesn't apply deduplication processes when you create a new account via the API. If your entry has the same name, domain, or other details as an existing account, Apollo creates a new account instead of updating the existing account. To update an existing account, use the Update an Account endpoint instead.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Accounts"],"operationId":"create-an-account","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name the account that you are creating. This should be a human-readable name.

Example: `The Irish Copywriters`"},"domain":{"type":"string","description":"The domain name for the account.

Do not include `www.` or similar.

Example: `apollo.io` or `microsoft.com`"},"owner_id":{"type":"string","description":"The ID for the account owner within your team's Apollo account.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"account_stage_id":{"type":"string","description":"The Apollo ID for the account stage to which you want to assign the account. Call the List Account Stages endpoint to retrieve a list of all the account stage IDs available in your Apollo account.

If you do not specify the account stage, Apollo automatically assigns the account to a stage as determined by your team's Apollo account. To change the order of account stages, launch the Apollo product and go to Settings > Objects > Accounts. Then, access the Triggers tab and change the stage for when an account is created.

Example: `6095a710bd01d100a506d4b9`"},"phone":{"type":"string","description":"The primary phone number for the account.

This can be the phone number for the corporate headquarters, a branch location, or a direct dial to the primary point of contact for the account.

Apollo sanitizes phone numbers, so you can enter them in any format. The sanitized number can be viewed in the endpoint response.

Examples: `555-555-0133`; `+44 7700 900852`"},"raw_address":{"type":"string","description":"The corporate location for the account. This can include a city, US state, and country.

Apollo matches the location you provide to the most applicable pre-defined location.

Examples: `Belfield, Dublin 4, Ireland`; `Dallas, United States`"},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"account":{"id":"66e9abf95ac32901b20d1a0d","domain":"irishcopywriters.ie","name":"The Irish Copywriters","team_id":"6095a710bd01d100a506d4ac","organization_id":null,"account_stage_id":"6095a710bd01d100a506d4b9","source":"api","original_source":"api","creator_id":null,"owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-17T16:19:05.663Z","phone":"555-555-0108","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+15555550108","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{"60c39ed82bd02f01154c470a":"2025-08-07"},"custom_field_errors":{},"modality":"account","source_display_name":"Created from API","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null}}}},"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"id":{"type":"string","example":"66e9abf95ac32901b20d1a0d"},"domain":{"type":"string","example":"irishcopywriters.ie"},"name":{"type":"string","example":"The Irish Copywriters"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"creator_id":{},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"created_at":{"type":"string","example":"2024-09-17T16:19:05.663Z"},"phone":{"type":"string","example":"555-555-0108"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+15555550108"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array"},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Created from API"},"crm_record_url":{},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/accounts/create is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/accounts/create is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add name or domain":{"value":"{\n \"error\": \"Please specify at least a name or domain.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Please specify at least a name or domain."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/accounts/{account_id}":{"patch":{"summary":"Update an Account","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\n An account is a company saved in Apollo.

Use the Update an Account endpoint to update existing accounts in your team's Apollo account.

To create a new account, use the Create an Account endpoint instead. To update the account stage for multiple accounts, use the Bulk Update Accounts endpoint.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Accounts"],"operationId":"update-an-account","parameters":[{"name":"account_id","in":"path","description":"The Apollo ID for the account that you want to update.

To find account IDs, call the Search for Accounts endpoint and identify the `id` value for the contact.

Example: `66e9abf95ac32901b20d1a0d`","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Update the account's name. This should be a human-readable name.

Example: `The Fast Irish Copywriters`"},"domain":{"type":"string","description":"Update the domain name for the account. Do not include `www.` or similar.

Example: `apollo.io` or `microsoft.com`"},"owner_id":{"type":"string","description":"The ID for the account owner within your team's Apollo account. Enter a different ID to update the owner of the account.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"account_stage_id":{"type":"string","description":"The Apollo ID for the account stage to which you want to assign the account. Enter a different ID to update the account stage.

Call the List Account Stages endpoint to retrieve a list of all the account stage IDs available in your Apollo account.

If you do not specify the account stage, Apollo automatically assigns the account to a stage as determined by your team's Apollo account. To change the order of account stages, launch the Apollo product and go to Settings > Objects > Accounts. Then, access the Triggers tab and change the stage for when an account is created.

Example: `61b8e913e0f4d2012e3af74e`"},"raw_address":{"type":"string","description":"Update the corporate location for the account. This can include a city, US state, and country.

Apollo matches the location you provide to the most applicable pre-defined location.

Examples: `Belfield, Dublin 4, Ireland`; `Dallas, United States`"},"phone":{"type":"string","description":"Update the primary phone number for the account.

This can be the phone number for the corporate headquarters, a branch location, or a direct dial to the primary point of contact for the account.

Apollo sanitizes phone numbers, so you can enter them in any format. The sanitized number can be viewed in the endpoint response.

Examples: `555-555-0133`; `+44 7700 900852`"},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"account":{"id":"66e9abf95ac32901b20d1a0d","domain":"irishcopywriters.com","name":"The Fast Irish Copywriters","team_id":"6095a710bd01d100a506d4ac","organization_id":null,"account_stage_id":"61b8e913e0f4d2012e3af74e","source":"api","original_source":"api","creator_id":null,"owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-17T16:19:05.663Z","phone":"555-555-0172","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+15555550172","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"custom_field_errors":{},"modality":"account","source_display_name":"Created from API","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"typed_custom_fields":{"60c39ed82bd02f01154c470a":"2025-08-07"}},"labels":[]}}},"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"id":{"type":"string","example":"66e9abf95ac32901b20d1a0d"},"domain":{"type":"string","example":"irishcopywriters.com"},"name":{"type":"string","example":"The Fast Irish Copywriters"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{},"account_stage_id":{"type":"string","example":"61b8e913e0f4d2012e3af74e"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"creator_id":{},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"created_at":{"type":"string","example":"2024-09-17T16:19:05.663Z"},"phone":{"type":"string","example":"555-555-0172"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+15555550172"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array"},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Created from API"},"crm_record_url":{},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}},"labels":{"type":"array"}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/accounts/update is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/accounts/update is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Check account ID":{"value":"{\n \"error\": \"Parameters misconfigured. account_id is not a valid ID\"\n}"},"Check owner ID":{"value":"{\n \"error\": \"Parameters misconfigured. 23423423 is not a valid ID\"\n}"},"Check account stage ID":{"value":"{\n \"error\": \"Parameters misconfigured. 78977 is not a valid ID\"\n}"}},"schema":{"oneOf":[{"title":"Check account ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. account_id is not a valid ID"}}},{"title":"Check owner ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 23423423 is not a valid ID"}}},{"title":"Check account stage ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 78977 is not a valid ID"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts/{account_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts/{account_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/accounts/search":{"post":{"summary":"Search for Accounts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\n An account is a company saved in Apollo.

Use the Search for Accounts endpoint to search for an account that has been saved to Apollo.

This endpoint only returns accounts in the search results. To search for companies in Apollo, call the Organization Search endpoint.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.","tags":["Accounts"],"operationId":"search-for-accounts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"q_organization_name":{"type":"string","description":"Add keywords to narrow the search of the accounts in your team's Apollo account. Keywords should directly match at least part of an account's name. For example, searching the keyword `marketing` might return the result `NY Marketing Unlimited`, but not `NY Market Analysts`. This parameter only searches account names, not other account fields. Examples: `apollo`; `microsoft`; `marketing`"},"account_stage_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for the account stages that you want to include in your search results. If you add multiple account stages, Apollo will include all accounts that match any of the stages, along with the other parameters, in the search results. Call the [List Account Stages endpoint](https://docs.apollo.io/reference/list-account-stages) to retrieve a list of all the account stage IDs available in your Apollo account. Example: `61b8e913e0f4d2012e3af74e`"},"account_label_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for the labels that you want to include in your search results. If you add multiple labels, Apollo will include all accounts connected to any of the labels, along with the other parameters, in the search results. Example: `['6095a710bd01d100a506d4ae']`"},"sort_by_field":{"type":"string","enum":["account_last_activity_date","account_created_at","account_updated_at"],"description":"Sort the matching accounts by 1 of the following options:\n- `account_last_activity_date`: The most recent activity date recorded first.\n- `account_created_at`: The most recently created first.\n- `account_updated_at`: The most recently updated first."},"sort_ascending":{"type":"boolean","default":false,"description":"Set to `true` to sort the matching accounts in ascending order. This parameter must be used with `sort_by_field`. Otherwise, the sorting logic is not applied. Example: `true`"},"page":{"type":"integer","format":"int32","description":"The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the `per_page` parameter to make search results navigable and improve the performance of the endpoint. Example: `4`"},"per_page":{"type":"integer","format":"int32","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. Use the `page` parameter to navigate through the different pages of data. Example: `10`"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"breadcrumbs":[{"label":"Company Name","signal_field_name":"q_organization_name","value":"Irish Copywriters","display_name":"Irish Copywriters"},{"label":"Account Stage","signal_field_name":"account_stage_ids","value":"61b8e913e0f4d2012e3af74e","display_name":"Lead"}],"partial_results_only":false,"has_join":false,"disable_eu_prospecting":false,"partial_results_limit":10000,"pagination":{"page":1,"per_page":5,"total_entries":1,"total_pages":1},"accounts":[{"id":"66e9abf95ac32901b20d1a0d","domain":"irishcopywriters.com","name":"The Fast Irish Copywriters","team_id":"6095a710bd01d100a506d4ac","organization_id":null,"account_stage_id":"61b8e913e0f4d2012e3af74e","label_ids":["68eec47ece3b0b000de4751f"],"source":"api","original_source":"api","creator_id":null,"owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-17T16:19:05.663Z","phone":"555-555-0172","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+15555550172","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","typed_custom_fields":{},"custom_field_errors":{},"modality":"account","source_display_name":"Created from API","crm_record_url":null,"contact_emailer_campaign_ids":[],"contact_campaign_status_tally":{},"num_contacts":0,"last_activity_date":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null}],"num_fetch_result":null}}},"schema":{"type":"object","properties":{"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","example":"Company Name"},"signal_field_name":{"type":"string","example":"q_organization_name"},"value":{"type":"string","example":"Irish Copywriters"},"display_name":{"type":"string","example":"Irish Copywriters"}}}},"partial_results_only":{"type":"boolean","example":false,"default":true},"has_join":{"type":"boolean","example":false,"default":true},"disable_eu_prospecting":{"type":"boolean","example":false,"default":true},"partial_results_limit":{"type":"integer","example":10000,"default":0},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":5,"default":0},"total_entries":{"type":"integer","example":1,"default":0},"total_pages":{"type":"integer","example":1,"default":0}}},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e9abf95ac32901b20d1a0d"},"domain":{"type":"string","example":"irishcopywriters.com"},"name":{"type":"string","example":"The Fast Irish Copywriters"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{},"account_stage_id":{"type":"string","example":"61b8e913e0f4d2012e3af74e"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"creator_id":{},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"created_at":{"type":"string","example":"2024-09-17T16:19:05.663Z"},"phone":{"type":"string","example":"555-555-0172"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+15555550172"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array"},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Created from API"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"has_intent_signal_account":{"type":"boolean","example":false,"default":true},"intent_signal_account":{}}}},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Choose valid sort_by_field option":{"value":"{\n \"error\": \"Invalid sort criteria\",\n \"skip_alert_dialog\": true\n}"},"Check account stage IDs":{"value":"{\n \"error\": \"Your search parameters are entered incorrectly. Did you try to edit the URL directly?\"\n}"}},"schema":{"oneOf":[{"title":"Choose valid sort_by_field option","type":"object","properties":{"error":{"type":"string","example":"Invalid sort criteria"},"skip_alert_dialog":{"type":"boolean","example":true,"default":true}}},{"title":"Check account stage IDs","type":"object","properties":{"error":{"type":"string","example":"Your search parameters are entered incorrectly. Did you try to edit the URL directly?"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/accounts/bulk_create":{"post":{"summary":"Bulk Create Accounts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAn account is a company saved in Apollo.

Use the bulk create accounts endpoint to create up to one hundred accounts in a single API request. This endpoint supports intelligent deduplication and returns separate arrays for newly created and existing accounts.

**Important**: This endpoint creates new accounts but doesn't update existing ones. Existing accounts that match the criteria are returned in the existing_accounts array without modification.

To update existing accounts, use the Bulk Update Accounts endpoint.","tags":["Accounts"],"operationId":"bulk-create-accounts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accounts"],"properties":{"accounts":{"type":"array","description":"Array of account attribute objects (maximum 100 accounts per request)","maxItems":100,"items":{"type":"object","properties":{"name":{"type":"string","description":"Account name","example":"Acme Corporation"},"domain":{"type":"string","description":"Company domain (e.g., 'example.com')","example":"acme.com"},"owner_id":{"type":"string","description":"Account owner user ID (BSON::ObjectId format). Defaults to current user if not provided","example":"507f1f77bcf86cd799439013"},"phone":{"type":"string","description":"Company phone number","example":"+1-555-0135"},"phone_status_cd":{"type":"string","description":"Phone validation status"},"raw_address":{"type":"string","description":"Company address","example":"123 Main St, San Francisco, CA 94105"},"linkedin_url":{"type":"string","description":"LinkedIn company page URL","example":"https://linkedin.com/company/acme"},"facebook_url":{"type":"string","description":"Facebook page URL","example":"https://facebook.com/acme"},"twitter_url":{"type":"string","description":"Twitter profile URL","example":"https://twitter.com/acme"},"salesforce_id":{"type":"string","description":"Salesforce account ID for CRM integration","example":"001pJNj9pix2idKsfj"},"hubspot_id":{"type":"string","description":"HubSpot company ID for CRM integration","example":"12345678"},"merged_crm_ids":{"type":"array","description":"Additional CRM IDs for deduplication","items":{"type":"string"}},"organization_id":{"type":"string","description":"Apollo organization ID","example":"507f1f77bcf86cd799439012"},"parent_account_id":{"type":"string","description":"Parent account ID for account hierarchy (BSON::ObjectId format)","example":"507f1f77bcf86cd799439016"},"account_stage_id":{"type":"string","description":"Account stage/pipeline stage ID (BSON::ObjectId format)","example":"507f1f77bcf86cd799439014"},"typed_custom_fields":{"type":"object","description":"Custom field values as key-value pairs where key is the field_id and value is the field_value","additionalProperties":{"type":"string"},"example":{"507f1f77bcf86cd799439020":"High Value","507f1f77bcf86cd799439021":"Q4 2025"}}}}},"append_label_names":{"type":"array","description":"Array of label names to add to ALL accounts in this request","items":{"type":"string"},"example":["Enterprise","High Priority"]},"run_dedupe":{"type":"boolean","description":"Enable aggressive deduplication by domain, organization_id, and name. When false (default), only matches by CRM IDs. When true, also matches by domain, organization_id, and name. Existing accounts are returned without modification in both modes","default":false,"example":true}}},"examples":{"Basic Account Creation":{"value":{"accounts":[{"name":"Acme Corporation","domain":"acme.com","phone":"+1-555-0135"},{"name":"TechStart Inc","domain":"example.com","linkedin_url":"https://linkedin.com/company/techstart"}]}},"With Deduplication (Returns Existing Without Updating)":{"value":{"accounts":[{"domain":"existing-company.com","name":"New Company Name"}],"run_dedupe":true}},"With CRM IDs (Returns Existing Without Updating)":{"value":{"accounts":[{"salesforce_id":"001pJNj9pix2idKsfj","name":"New Name","phone":"+1-555-0159"},{"hubspot_id":"12345678","name":"Another New Name"}]}},"With Custom Fields and Labels":{"value":{"accounts":[{"name":"Enterprise Client","domain":"example.com","account_stage_id":"507f1f77bcf86cd799439014","typed_custom_fields":{"507f1f77bcf86cd799439020":"High Value","507f1f77bcf86cd799439021":"Q4 2025"}}],"append_label_names":["Enterprise","Priority"]}}}}}},"responses":{"200":{"description":"200 - Successful bulk create operation","content":{"application/json":{"examples":{"Result":{"value":{"created_accounts":[{"id":"507f1f77bcf86cd799439011","name":"Acme Corporation","domain":"acme.com","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","account_stage_id":"507f1f77bcf86cd799439014","phone":"+1-555-0135","created_at":"2025-10-16T18:30:00Z","updated_at":"2025-10-16T18:30:00Z"},{"id":"507f1f77bcf86cd799439017","name":"TechStart Inc","domain":"example.com","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","linkedin_url":"https://linkedin.com/company/techstart","created_at":"2025-10-16T18:30:00Z","updated_at":"2025-10-16T18:30:00Z"}],"existing_accounts":[{"id":"507f1f77bcf86cd799439015","name":"Original Company Name","domain":"existing.com","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","created_at":"2025-09-01T10:00:00Z","updated_at":"2025-09-15T14:30:00Z"}]}}},"schema":{"type":"object","properties":{"created_accounts":{"type":"array","description":"Array of newly created accounts","items":{"type":"object","properties":{"id":{"type":"string","description":"Account ID","example":"507f1f77bcf86cd799439011"},"name":{"type":"string","description":"Account name","example":"Acme Corporation"},"domain":{"type":"string","description":"Company domain","example":"acme.com"},"team_id":{"type":"string","description":"Team ID","example":"507f1f77bcf86cd799439012"},"owner_id":{"type":"string","description":"Account owner ID","example":"507f1f77bcf86cd799439013"},"account_stage_id":{"type":"string","description":"Account stage ID","example":"507f1f77bcf86cd799439014"},"phone":{"type":"string","description":"Company phone number","example":"+1-555-0135"},"created_at":{"type":"string","format":"date-time","description":"Account creation timestamp","example":"2025-10-16T18:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Account last update timestamp","example":"2025-10-16T18:30:00Z"}}}},"existing_accounts":{"type":"array","description":"Array of existing accounts that matched deduplication criteria (returned without modification)","items":{"type":"object","properties":{"id":{"type":"string","description":"Account ID","example":"507f1f77bcf86cd799439015"},"name":{"type":"string","description":"Account name","example":"Original Company Name"},"domain":{"type":"string","description":"Company domain","example":"existing.com"},"team_id":{"type":"string","description":"Team ID","example":"507f1f77bcf86cd799439012"},"owner_id":{"type":"string","description":"Account owner ID","example":"507f1f77bcf86cd799439013"},"created_at":{"type":"string","format":"date-time","description":"Account creation timestamp","example":"2025-09-01T10:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Account last update timestamp","example":"2025-09-15T14:30:00Z"}}}}}}}}},"401":{"description":"401 - Unauthorized","content":{"text/plain":{"examples":{"Invalid API Key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422 - Unprocessable Entity","content":{"application/json":{"examples":{"Missing accounts parameter":{"value":"{\n \"error\": \"Please provide an array of account attributes in the \\\"accounts\\\" parameter.\"\n}"},"Too many accounts":{"value":"{\n \"error\": \"Please limit your array to 100 accounts or fewer.\"\n}"},"Invalid accounts parameter":{"value":"{\n \"error\": \"Please provide an array of account attributes in the \\\"accounts\\\" parameter.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Please provide an array of account attributes in the \"accounts\" parameter."}}}}}},"429":{"description":"429 - Too Many Requests","content":{"application/json":{"examples":{"Rate limit exceeded":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}},"500":{"description":"500 - Internal Server Error","content":{"application/json":{"examples":{"Server error":{"value":"{\n \"error\": \"An error occurred while creating accounts. Please try again.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"An error occurred while creating accounts. Please try again."}}}}}}},"deprecated":false}},"/accounts/bulk_update":{"post":{"summary":"Bulk Update Accounts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAn account is a company saved in Apollo.

Use the Bulk Update Accounts endpoint to simultaneously update multiple accounts in your team's Apollo account.

This endpoint allows you to update common fields across multiple accounts efficiently, such as account stages, owners, names, and custom fields.

You can update up to 1,000 accounts per request.

Important: Asynchronous processing (async parameter) is only supported when using account_ids to apply the same updates to all accounts. If you use async with account_attributes (individual updates per account), the request fails with a 422 error.","tags":["Accounts"],"operationId":"bulk-update-accounts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"account_ids":{"type":"array","description":"Array of account IDs to update with the same values. Use this for applying the same updates to multiple accounts.","items":{"type":"string"},"example":["66e9abf95ac32901b20d1a0d","66e9a4db056fe802d331fb8a"]},"account_attributes":{"type":"array","description":"Array of account objects with individual updates. Use this for applying different updates to each account.","items":{"type":"object","properties":{"id":{"type":"string","description":"The account ID to update","example":"66e9abf95ac32901b20d1a0d"},"name":{"type":"string","description":"The account name","example":"Acme Corporation"},"owner_id":{"type":"string","description":"The Apollo user ID to assign as owner","example":"66302798d03b9601c7934ebf"},"account_stage_id":{"type":"string","description":"The Apollo account stage ID","example":"6095a710bd01d100a506d4b7"},"typed_custom_fields":{"type":"object","description":"Custom field values as key-value pairs","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}},"required":["id"]}},"name":{"type":"string","description":"When using account_ids, apply this name to all accounts","example":"Updated Account Name"},"owner_id":{"type":"string","description":"When using account_ids, apply this owner to all accounts","example":"66302798d03b9601c7934ebf"},"account_stage_id":{"type":"string","description":"When using account_ids, apply this account stage to all accounts","example":"6095a710bd01d100a506d4b7"},"async":{"type":"boolean","description":"Set to true to process updates asynchronously. Only available when using account_ids. Not supported with account_attributes.","example":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"accounts\": [\n {\n \"id\": \"66e9abf95ac32901b20d1a0d\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b7\"\n },\n {\n \"id\": \"66e9a4db056fe802d331fb8a\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b7\"\n },\n {\n \"id\": \"66e9a7866e440201b42ac31d\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b7\"\n }\n ]\n}"}},"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e9abf95ac32901b20d1a0d"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b7"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/accounts/bulk_update is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/accounts/bulk_update is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Async not permitted with account_attributes":{"value":"{\n \"error\": \"Async processing is not permitted.\"\n}"},"Too many accounts":{"value":"{\n \"error\": \"Please limit your array to fewer than 1000.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Async processing is not permitted."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts/bulk_update is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts/bulk_update is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/accounts/update_owners":{"post":{"summary":"Update Account Owner for Multiple Accounts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAccount owners manage saved accounts in Apollo.

Use the Update Account Owner for Multiple Accounts endpoint to assign multiple accounts to a different user in your team's Apollo account.

To update more than the account owner, such as domains or phone numbers, use the Update an Account endpoint instead.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Accounts"],"operationId":"update-account-ownership","parameters":[{"name":"account_ids[]","in":"query","description":"The Apollo IDs for the account that you want to assign to an owner.

To find account IDs, call the Search for Accounts endpoint and identify the `id` value for the account.

Example: `66e9abf95ac32901b20d1a0d`","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"owner_id","in":"query","description":"The ID for the account owner within your team's Apollo account. This user will be assigned ownership of the accounts.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"accounts":[{"id":"66e9a4db056fe802d331fb8a","owner_id":"66302798d03b9601c7934ebf","crm_owner_id":null},{"id":"66e9abf95ac32901b20d1a0d","owner_id":"66302798d03b9601c7934ebf","crm_owner_id":null},{"id":"66e9a7866e440201b42ac31d","owner_id":"66302798d03b9601c7934ebf","crm_owner_id":null}]}}},"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e9a4db056fe802d331fb8a"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"crm_owner_id":{}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/users/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/users/search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add account IDs":{"value":"{\n \"error\": \"Required parameter 'account_ids' missing\"\n}"},"Add owner ID":{"value":"{\n \"error\": \"Required parameter 'owner_id' missing\"\n}"}},"schema":{"oneOf":[{"title":"Add account IDs","type":"object","properties":{"error":{"type":"string","example":"Required parameter 'account_ids' missing"}}},{"title":"Add owner ID","type":"object","properties":{"error":{"type":"string","example":"Required parameter 'owner_id' missing"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/accounts/update_owners is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/accounts/update_owners is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/account_stages":{"get":{"summary":"List Account Stages","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAccount stages help you track progress on sales and marketing pipelines.

Use the List Accounts Stages endpoint to retrieve the IDs for the available account stages in your team's Apollo account. This endpoint doesn't require parameters.

Account stage IDs can be used to update individual accounts and update the account stages for multiple accounts via Apollo API.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Accounts"],"operationId":"list-account-stages","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"account_stages\": [\n {\n \"id\": \"6095a710bd01d100a506d4b7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Review\",\n \"name\": \"Review\",\n \"display_order\": 1,\n \"default_exclude_for_leadgen\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b8\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Current Client\",\n \"name\": \"Current Client\",\n \"display_order\": 2,\n \"default_exclude_for_leadgen\": true,\n \"category\": \"succeeded\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b9\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Active Opportunity\",\n \"name\": \"Active Opportunity\",\n \"display_order\": 3,\n \"default_exclude_for_leadgen\": true,\n \"category\": \"succeeded\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4ba\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Dead Opportunity\",\n \"name\": \"Dead Opportunity\",\n \"display_order\": 4,\n \"default_exclude_for_leadgen\": false,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4bb\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Do Not Prospect\",\n \"name\": \"Do Not Prospect\",\n \"display_order\": 5,\n \"default_exclude_for_leadgen\": true,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af74c\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Subscriber\",\n \"name\": \"Subscriber\",\n \"display_order\": 6,\n \"default_exclude_for_leadgen\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af74e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Lead\",\n \"name\": \"Lead\",\n \"display_order\": 7,\n \"default_exclude_for_leadgen\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af750\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Marketing Qualified Lead\",\n \"name\": \"Marketing Qualified Lead\",\n \"display_order\": 8,\n \"default_exclude_for_leadgen\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af752\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Sales Qualified Lead\",\n \"name\": \"Sales Qualified Lead\",\n \"display_order\": 9,\n \"default_exclude_for_leadgen\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af754\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Evangelist\",\n \"name\": \"Evangelist\",\n \"display_order\": 10,\n \"default_exclude_for_leadgen\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af756\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Other\",\n \"name\": \"Other\",\n \"display_order\": 11,\n \"default_exclude_for_leadgen\": false,\n \"category\": null,\n \"is_meeting_set\": null\n }\n ]\n}"}},"schema":{"type":"object","properties":{"account_stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6095a710bd01d100a506d4b7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"display_name":{"type":"string","example":"Review"},"name":{"type":"string","example":"Review"},"display_order":{"type":"integer","example":1,"default":0},"default_exclude_for_leadgen":{"type":"boolean","example":false,"default":true},"category":{},"is_meeting_set":{}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/account_stages/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/account_stages/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/account_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/account_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts":{"post":{"summary":"Create a Contact","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the Create a Contact endpoint to add a new contact to your team's Apollo account.

By default, Apollo doesn't apply deduplication processes when you create a new contact via API. If your entry has the same name, email address, or other details as an existing contact, Apollo creates a new contact instead of updating the existing contact. To enable deduplication and prevent duplicate contacts, set the run_dedupe parameter to true.

To update an existing contact, use the Update a Contact endpoint instead.","tags":["Contacts"],"operationId":"create-a-contact","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"The first name of the contact you want to create. Example: `Tim`"},"last_name":{"type":"string","description":"The last name of the contact you want to create. Example: `Zheng`"},"organization_name":{"type":"string","description":"The name of the contact's employer (company). Example: `apollo`"},"title":{"type":"string","description":"The current job title that the contact holds. Example: `senior research analyst`"},"account_id":{"type":"string","description":"The Apollo ID for the account. Example: `63f53afe4ceeca00016bdd2f`"},"email":{"type":"string","description":"The email address of the contact. Example: `example@email.com`"},"website_url":{"type":"string","description":"The corporate website URL. Example: `https://www.apollo.io/`"},"label_names":{"type":"array","description":"Lists to which the contact belongs.","items":{"type":"string"}},"contact_stage_id":{"type":"string","description":"The Apollo ID for the contact stage. Example: `6095a710bd01d100a506d4ae`"},"present_raw_address":{"type":"string","description":"The personal location for the contact. Example: `Atlanta, United States`"},"direct_phone":{"type":"string","description":"The primary phone number. Example: `555-555-0133`"},"corporate_phone":{"type":"string","description":"The work/office phone number. Example: `+44 7700 900852`"},"mobile_phone":{"type":"string","description":"The mobile phone number. Example: `555-555-0133`"},"home_phone":{"type":"string","description":"The home phone number. Example: `555-555-0133`"},"other_phone":{"type":"string","description":"Alternative phone number. Example: `555-555-0133`"},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}},"run_dedupe":{"type":"boolean","description":"Set to `true` to enable deduplication logic that prevents creating duplicate contacts. When enabled, Apollo will check for existing contacts with matching email addresses, names, or other identifying information and return the existing contact instead of creating a duplicate. The default value is `false`.

When deduplication is enabled, performance may be slightly impacted due to the additional validation checks, but this ensures data integrity and prevents duplicate entries in your database.","default":false}}},"examples":{"Create contact without deduplication":{"summary":"Create a new contact without deduplication (default behavior)","value":{"first_name":"John","last_name":"Smith","email":"john.smith@example.com","organization_name":"Example Corp","title":"Software Engineer"}},"Create contact with deduplication":{"summary":"Create a new contact with deduplication enabled","value":{"first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","organization_name":"Example Corp","title":"Product Manager","run_dedupe":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"contact":{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Fyodor","last_name":"Dostoevsky","name":"Fyodor Dostoevsky","linkedin_url":null,"title":"Chief Fiction Writer","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"60affe7d6e270a00f5db6fe4","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":"5e66b6381e05b4008c8331b8","headline":null,"photo_url":null,"present_raw_address":"St. Petersburg, Russia","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"63f53afe4ceeca00016bdd2f","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550149","merged_crm_ids":null,"updated_at":"2024-09-12T20:13:53.331Z","queued_for_crm_push":true,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":["66e34b81740c50074e3d1bd0","66e34b81740c50074e3d1bd1","66e34b81740c50074e3d1bd2","66e34b81740c50074e3d1bd3"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"fyodo@apollo.io","email_from_customer":true,"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Created from API","twitter_url":null,"contact_campaign_statuses":[],"contact_emails":[],"next_contact_id":null,"time_zone":"Asia/Krasnoyarsk","city":"Saint Petersburg","state":"Saint Petersburg","country":"Russia","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"555-555-0149","sanitized_number":"+15555550149","type":"work_direct","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":null,"dialer_flags":null}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false,"email_domain_catchall":false,"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"}},"labels":[{"id":"66e34b81740c50074e3d1bd2","modality":"contacts","cached_count":0,"name":"typewriter","created_at":"2024-09-12T20:13:53.119Z","updated_at":"2024-09-12T20:13:53.279Z","user_id":"60affe7d6e270a00f5db6fe4"},{"id":"66e34b81740c50074e3d1bd1","modality":"contacts","cached_count":0,"name":"fiction","created_at":"2024-09-12T20:13:53.107Z","updated_at":"2024-09-12T20:13:53.258Z","user_id":"60affe7d6e270a00f5db6fe4"},{"id":"66e34b81740c50074e3d1bd0","modality":"contacts","cached_count":0,"name":"writer","created_at":"2024-09-12T20:13:53.093Z","updated_at":"2024-09-12T20:13:53.308Z","user_id":"60affe7d6e270a00f5db6fe4"},{"id":"66e34b81740c50074e3d1bd3","modality":"contacts","cached_count":0,"name":"microsoft word","created_at":"2024-09-12T20:13:53.132Z","updated_at":"2024-09-12T20:13:53.313Z","user_id":"60affe7d6e270a00f5db6fe4"}]}},"Deduplication-Result":{"summary":"Contact creation with deduplication enabled - existing contact found","value":{"contact":{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Jane","last_name":"Doe","name":"Jane Doe","linkedin_url":null,"title":"Product Manager","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"60affe7d6e270a00f5db6fe4","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Example Corp","source":"api","original_source":"api","organization_id":"5e66b6381e05b4008c8331b8","headline":null,"photo_url":null,"present_raw_address":null,"linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"63f53afe4ceeca00016bdd2f","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":null,"merged_crm_ids":null,"updated_at":"2024-09-12T20:13:53.331Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"jane.doe@example.com","email_from_customer":true,"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Created from API","twitter_url":null,"contact_campaign_statuses":[],"contact_emails":[],"next_contact_id":null,"time_zone":null,"city":null,"state":null,"country":null,"intent_strength":null,"show_intent":false,"phone_numbers":[],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false,"email_domain_catchall":false,"typed_custom_fields":{}},"labels":[],"dedupe_result":{"found_existing":true,"match_reason":"email_match","existing_contact_id":"66e34b81740c50074e3d1bd4"}}}},"schema":{"type":"object","properties":{"contact":{"type":"object","properties":{"contact_roles":{"type":"array"},"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"Fyodor"},"last_name":{"type":"string","example":"Dostoevsky"},"name":{"type":"string","example":"Fyodor Dostoevsky"},"linkedin_url":{},"title":{"type":"string","example":"Chief Fiction Writer"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4ae"},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"person_id":{},"email_needs_tickling":{},"organization_name":{"type":"string","example":"Apollo.io"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"headline":{},"photo_url":{},"present_raw_address":{"type":"string","example":"St. Petersburg, Russia"},"linkedin_uid":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"salesforce_id":{},"salesforce_lead_id":{},"salesforce_contact_id":{},"salesforce_account_id":{},"crm_owner_id":{},"created_at":{"type":"string","example":"2024-09-12T20:13:53.207Z"},"emailer_campaign_ids":{"type":"array"},"direct_dial_status":{},"direct_dial_enrichment_failed_at":{},"email_status":{"type":"string","example":"verified"},"email_source":{},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"last_activity_date":{},"hubspot_vid":{},"hubspot_company_id":{},"crm_id":{},"sanitized_phone":{"type":"string","example":"+15555550149"},"merged_crm_ids":{},"updated_at":{"type":"string","example":"2024-09-12T20:13:53.331Z"},"queued_for_crm_push":{"type":"boolean","example":true,"default":true},"suggested_from_rule_engine_config_id":{},"email_unsubscribed":{},"label_ids":{"type":"array","items":{"type":"string","example":"66e34b81740c50074e3d1bd0"}},"has_pending_email_arcgate_request":{"type":"boolean","example":false,"default":true},"has_email_arcgate_request":{"type":"boolean","example":false,"default":true},"existence_level":{"type":"string","example":"full"},"email":{"type":"string","example":"fyodo@apollo.io"},"email_from_customer":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"crm_record_url":{},"email_status_unavailable_reason":{},"email_true_status":{"type":"string","example":"User Managed"},"updated_email_true_status":{"type":"boolean","example":true,"default":true},"contact_rule_config_statuses":{"type":"array"},"source_display_name":{"type":"string","example":"Created from API"},"twitter_url":{},"contact_campaign_statuses":{"type":"array","description":"Array of campaign statuses for the contact, showing their participation in various email sequences","items":{"type":"object","description":"Contact campaign status object representing the contact's current state in a specific email sequence","properties":{"id":{"type":"string","description":"Unique identifier for this contact campaign status record","example":"68782af181c7f0002159df25"},"emailer_campaign_id":{"type":"string","description":"ID of the email sequence (emailer campaign) this status belongs to","example":"66e9e215ece19801b219997f"},"send_email_from_user_id":{"type":"string","description":"ID of the user who is sending emails for this contact in the sequence","example":"66302798d03b9601c7934ebf"},"inactive_reason":{"type":"string","nullable":true,"description":"Reason why the contact is inactive in this sequence, if applicable","example":"Sequence inactive"},"status":{"type":"string","description":"Current status of the contact in this email sequence","enum":["active","failed","paused","finished"],"example":"paused"},"added_at":{"type":"string","format":"date-time","description":"Timestamp when the contact was added to this sequence","example":"2025-07-16T22:42:57.372+00:00"},"added_by_user_id":{"type":"string","description":"ID of the user who added this contact to the sequence","example":"60affe7d6e270a00f5db6fe4"},"finished_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the contact finished/completed the sequence","example":null},"paused_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the contact was paused in the sequence","example":null},"auto_unpause_at":{"type":"string","format":"date-time","nullable":true,"description":"Scheduled timestamp for automatically unpausing the contact","example":null},"send_email_from_email_address":{"type":"string","nullable":true,"description":"Specific email address used to send emails to this contact","example":"test.marcus.hale@apollomail.io"},"send_email_from_email_account_id":{"type":"string","description":"ID of the email account used to send emails to this contact","example":"6633baaece5fbd01c791d7ca"},"manually_set_unpause":{"type":"boolean","nullable":true,"description":"Whether the unpause was manually set by a user","example":null},"failure_reason":{"type":"string","nullable":true,"description":"Specific reason for failure if status is 'failed'","enum":["hard_bounced","spam_blocked","bounced","past_date_failure"],"example":null},"current_step_id":{"type":"string","nullable":true,"description":"ID of the current step in the sequence that the contact is on","example":null},"in_response_to_emailer_message_id":{"type":"string","nullable":true,"description":"ID of the emailer message this campaign status is in response to","example":null},"cc_emails":{"type":"array","nullable":true,"description":"Email addresses to CC when sending emails to this contact","items":{"type":"string"},"example":null},"bcc_emails":{"type":"array","nullable":true,"description":"Email addresses to BCC when sending emails to this contact","items":{"type":"string"},"example":null},"to_emails":{"type":"array","nullable":true,"description":"Additional email addresses to include in TO field when sending emails","items":{"type":"string"},"example":null},"current_step_position":{"type":"integer","nullable":true,"description":"Position number of the current step in the sequence (1-based indexing)","example":null}},"required":["id","emailer_campaign_id","send_email_from_user_id","status","added_at","added_by_user_id","send_email_from_email_account_id"]}},"contact_emails":{"type":"array"},"next_contact_id":{},"time_zone":{"type":"string","example":"Asia/Krasnoyarsk"},"city":{"type":"string","example":"Saint Petersburg"},"state":{"type":"string","example":"Saint Petersburg"},"country":{"type":"string","example":"Russia"},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"raw_number":{"type":"string","example":"555-555-0149"},"sanitized_number":{"type":"string","example":"+15555550149"},"type":{"type":"string","example":"work_direct"},"position":{"type":"integer","example":0,"default":0},"status":{"type":"string","example":"no_status"},"dnc_status":{},"dnc_other_info":{},"dialer_flags":{}}}},"account_phone_note":{},"free_domain":{"type":"boolean","example":false,"default":true},"is_likely_to_engage":{"type":"boolean","example":false,"default":true},"email_domain_catchall":{"type":"boolean","example":false,"default":true}}},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd2"},"modality":{"type":"string","example":"contacts"},"cached_count":{"type":"integer","example":0,"default":0},"name":{"type":"string","example":"typewriter"},"created_at":{"type":"string","example":"2024-09-12T20:13:53.119Z"},"updated_at":{"type":"string","example":"2024-09-12T20:13:53.279Z"},"user_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Check the account ID":{"value":"{\n \"error\": \"Parameters misconfigured. 63f53afe4ceeca00016bdd2fsfsdf is not a valid ID\"\n}"},"Check the contact stage ID":{"value":"{\n \"error\": \"Parameters misconfigured. 2342432 is not a valid ID\"\n}"}},"schema":{"oneOf":[{"title":"Check the account ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 63f53afe4ceeca00016bdd2fsfsdf is not a valid ID"}}},{"title":"Check the contact stage ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 2342432 is not a valid ID"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/{contact_id}":{"patch":{"summary":"Update a Contact","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the Update a Contact endpoint to update existing contacts in your team's Apollo account.

To create a new contact, use the Create a Contact endpoint instead. To update the contact stage for multiple contacts, use the Update Contact Stage for Multiple Contacts endpoint.","tags":["Contacts"],"operationId":"update-a-contact","parameters":[{"name":"contact_id","in":"path","description":"The Apollo ID for the contact that you want to update.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"Update the contact's first name. Example: `Tim`"},"last_name":{"type":"string","description":"Update the contact's last name. Example: `Zheng`"},"organization_name":{"type":"string","description":"Update the employer (company) name. Example: `apollo`"},"title":{"type":"string","description":"Update the job title. Example: `senior research analyst`"},"account_id":{"type":"string","description":"Update the account ID. Example: `63f53afe4ceeca00016bdd2f`"},"email":{"type":"string","description":"Update the contact email. Example: `example@email.com`"},"website_url":{"type":"string","description":"Update the employer website URL. Example: `https://www.apollo.io/`"},"label_names":{"type":"array","description":"Replace lists this contact belongs to. (Passing new values will overwrite existing lists.)","items":{"type":"string"}},"contact_stage_id":{"type":"string","description":"Update the contact stage ID. Example: `6095a710bd01d100a506d4af`"},"present_raw_address":{"type":"string","description":"Update location (city/state/country). Example: `Atlanta, United States`"},"direct_phone":{"type":"string","description":"Primary phone."},"corporate_phone":{"type":"string","description":"Work/office phone."},"mobile_phone":{"type":"string","description":"Mobile phone."},"home_phone":{"type":"string","description":"Home phone."},"other_phone":{"type":"string","description":"Alternate phone."},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"contact":{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Fyodor","last_name":"Dostoevsky","name":"Fyodor Dostoevsky","linkedin_url":null,"title":"Chief Writer","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"60affe7d6e270a00f5db6fe4","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":"5e66b6381e05b4008c8331b8","headline":null,"photo_url":null,"present_raw_address":"St. Petersburg, Russia","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"63f53afe4ceeca00016bdd2f","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550117","merged_crm_ids":null,"updated_at":"2024-09-12T20:14:53.134Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":["66e361494acd1307386d4073"],"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"},"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"fyodor.dostoevsky@apollo.io","email_from_customer":true,"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Created from API","twitter_url":null,"contact_emails":[],"next_contact_id":null,"time_zone":"Asia/Krasnoyarsk","city":"Saint Petersburg","state":"Saint Petersburg","country":"Russia","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"555-555-0117","sanitized_number":"+15555550117","type":"work_direct","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":null,"dialer_flags":null}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false,"email_domain_catchall":false},"labels":[{"id":"66e361494acd1307386d4073","modality":"contacts","cached_count":0,"name":"2024 fiction writers of america attendees","created_at":"2024-09-12T21:46:49.464Z","updated_at":"2024-09-12T21:46:49.544Z","user_id":"60affe7d6e270a00f5db6fe4"}]}}},"schema":{"type":"object","properties":{"contact":{"type":"object","properties":{"contact_roles":{"type":"array"},"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"Fyodor"},"last_name":{"type":"string","example":"Dostoevsky"},"name":{"type":"string","example":"Fyodor Dostoevsky"},"linkedin_url":{},"title":{"type":"string","example":"Chief Writer"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4ae"},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"person_id":{},"email_needs_tickling":{},"organization_name":{"type":"string","example":"Apollo.io"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"headline":{},"photo_url":{},"present_raw_address":{"type":"string","example":"St. Petersburg, Russia"},"linkedin_uid":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"salesforce_id":{},"salesforce_lead_id":{},"salesforce_contact_id":{},"salesforce_account_id":{},"crm_owner_id":{},"created_at":{"type":"string","example":"2024-09-12T20:13:53.207Z"},"emailer_campaign_ids":{"type":"array"},"direct_dial_status":{},"direct_dial_enrichment_failed_at":{},"email_status":{"type":"string","example":"verified"},"email_source":{},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"last_activity_date":{},"hubspot_vid":{},"hubspot_company_id":{},"crm_id":{},"sanitized_phone":{"type":"string","example":"+15555550117"},"merged_crm_ids":{},"updated_at":{"type":"string","example":"2024-09-12T20:14:53.134Z"},"queued_for_crm_push":{"type":"boolean","example":false,"default":true},"suggested_from_rule_engine_config_id":{},"email_unsubscribed":{},"label_ids":{"type":"array","items":{"type":"string","example":"66e361494acd1307386d4073"}},"has_pending_email_arcgate_request":{"type":"boolean","example":false,"default":true},"has_email_arcgate_request":{"type":"boolean","example":false,"default":true},"existence_level":{"type":"string","example":"full"},"email":{"type":"string","example":"fyodor.dostoevsky@apollo.io"},"email_from_customer":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"crm_record_url":{},"email_status_unavailable_reason":{},"email_true_status":{"type":"string","example":"User Managed"},"updated_email_true_status":{"type":"boolean","example":true,"default":true},"contact_rule_config_statuses":{"type":"array"},"source_display_name":{"type":"string","example":"Created from API"},"twitter_url":{},"contact_emails":{"type":"array"},"next_contact_id":{},"time_zone":{"type":"string","example":"Asia/Krasnoyarsk"},"city":{"type":"string","example":"Saint Petersburg"},"state":{"type":"string","example":"Saint Petersburg"},"country":{"type":"string","example":"Russia"},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"raw_number":{"type":"string","example":"555-555-0117"},"sanitized_number":{"type":"string","example":"+15555550117"},"type":{"type":"string","example":"work_direct"},"position":{"type":"integer","example":0,"default":0},"status":{"type":"string","example":"no_status"},"dnc_status":{},"dnc_other_info":{},"dialer_flags":{}}}},"account_phone_note":{},"free_domain":{"type":"boolean","example":false,"default":true},"is_likely_to_engage":{"type":"boolean","example":false,"default":true},"email_domain_catchall":{"type":"boolean","example":false,"default":true}}},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e361494acd1307386d4073"},"modality":{"type":"string","example":"contacts"},"cached_count":{"type":"integer","example":0,"default":0},"name":{"type":"string","example":"2024 fiction writers of america attendees"},"created_at":{"type":"string","example":"2024-09-12T21:46:49.464Z"},"updated_at":{"type":"string","example":"2024-09-12T21:46:49.544Z"},"user_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Check the account ID":{"value":"{\n \"error\": \"Parameters misconfigured. 5234234 is not a valid ID\"\n}"},"Check the contact stage ID":{"value":"{\n \"error\": \"Parameters misconfigured. 2342432 is not a valid ID\"\n}"},"Contact has been deleted":{"value":"{\n \"error\": \"Cannot update contact as it is deleted.\",\n \"deleted_contact_ids\": [\n \"66e34b81740c50074e3d1bd4\"\n ]\n}"}},"schema":{"oneOf":[{"title":"Check the account ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 5234234 is not a valid ID"}}},{"title":"Check the contact stage ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 2342432 is not a valid ID"}}},{"title":"Contact has been deleted","type":"object","properties":{"error":{"type":"string","example":"Cannot update contact as it is deleted."},"deleted_contact_ids":{"type":"array","items":{"type":"string","example":"66e34b81740c50074e3d1bd4"}}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/{contact_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/{contact_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false},"get":{"summary":"View a Contact","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the View a Contact endpoint to retrieve details for an existing contact in your team's Apollo database.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Contacts"],"operationId":"view-a-contact","parameters":[{"name":"contact_id","in":"path","description":"The Apollo ID for the contact that you want to view.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"contact":{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Fyodor","last_name":"Dostoevsky","name":"Fyodor Dostoevsky","linkedin_url":null,"title":"Chief Writer","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"60affe7d6e270a00f5db6fe4","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":"5e66b6381e05b4008c8331b8","headline":null,"photo_url":null,"present_raw_address":"St. Petersburg, Russia","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"63f53afe4ceeca00016bdd2f","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550117","merged_crm_ids":null,"updated_at":"2024-09-12T20:14:53.134Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":["66e361494acd1307386d4073"],"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"},"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"fyodor.dostoevsky@apollo.io","email_from_customer":true,"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Created from API","twitter_url":null,"contact_emails":[],"next_contact_id":null,"time_zone":"Asia/Krasnoyarsk","city":"Saint Petersburg","state":"Saint Petersburg","country":"Russia","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"555-555-0117","sanitized_number":"+15555550117","type":"work_direct","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":null,"dialer_flags":null}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false,"email_domain_catchall":false},"labels":[{"id":"66e361494acd1307386d4073","modality":"contacts","cached_count":0,"name":"2024 fiction writers of america attendees","created_at":"2024-09-12T21:46:49.464Z","updated_at":"2024-09-12T21:46:49.544Z","user_id":"60affe7d6e270a00f5db6fe4"}]}}},"schema":{"type":"object","properties":{"contact":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@example.com"},"title":{"type":"string","example":"VP of Sales"},"organization_name":{"type":"string","example":"Acme Corp"},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4ae"},"linkedin_url":{"type":"string","example":"https://linkedin.com/in/john-doe-3f9a7c21"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"raw_number":{"type":"string"},"sanitized_number":{"type":"string"},"type":{"type":"string"}}}},"typed_custom_fields":{"type":"object","additionalProperties":{"type":"string"}},"label_ids":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","example":"2023-01-01T00:00:00.000Z"},"updated_at":{"type":"string","example":"2023-01-02T00:00:00.000Z"}}}}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":{"error":"api/v1/contacts/{contact_id} is not accessible with this api_key","error_code":"API_INACCESSIBLE"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/contacts/{contact_id} is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Contact not found":{"value":{"error":"Oops! This contact does not exist in Apollo."}},"Contact deleted":{"value":{"error":"This contact has been deleted."}},"Unauthorized":{"value":{"error":"You are not authorized to view this page."}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Oops! This contact does not exist in Apollo."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"message":"The maximum number of api calls allowed for api/v1/contacts/{contact_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/{contact_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/{contact_id}/opportunities":{"post":{"summary":"View Associated Deals","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the View Associated Deals endpoint to retrieve the deals associated with a contact.

This endpoint doesn't require a request body. If you include one, Apollo doesn't read its fields. An empty JSON {} is sufficient.

Each result returns the same deal details as View Deal endpoint. If the contact has no associated deals or the contact ID isn't recognized, Apollo returns a 200 response with an empty array rather than a 404 error.","tags":["Contacts"],"operationId":"view-associated-deals","parameters":[{"name":"contact_id","in":"path","required":true,"description":"The ID for the contact whose associated deals you want to retrieve.

Example: 64a7ff0cc4dfae00013df1a5","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Empty body":{"value":{}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Contact with associated deals":{"value":{"opportunities":[{"id":"66e09ea8e3cfcf01b2208ec7","team_id":"6095a710bd01d100a506d4ac","owner_id":"66302798d03b9601c7934ebf","salesforce_owner_id":null,"amount":99999999,"closed_date":null,"account_id":"60afffecbff6de00a4b82be7","description":null,"is_closed":false,"is_won":false,"name":"Massive Space Deal","stage_name":null,"opportunity_stage_id":"6095a710bd01d100a506d4bd","source":"api","salesforce_id":null,"created_at":"2024-09-10T19:31:52.436Z","actual_close_date":null,"next_step":null,"next_step_date":null,"closed_lost_reason":null,"closed_won_reason":null,"forecast_category":"pipeline","deal_probability":10,"created_by_id":"60affe7d6e270a00f5db6fe4","current_solutions":null,"deal_source":null,"manually_updated_probability":null,"manually_updated_forecast":null,"crm_id":null,"crm_record_url":null,"crm_owner_id":null,"probability":null,"opportunity_pipeline_id":"654b989fcb2a5200010a90db","stage_updated_at":"2024-09-10T19:33:40.529+00:00","next_step_last_updated_at":null,"exchange_rate_code":"USD","exchange_rate_value":1,"amount_in_team_currency":99999999,"forecasted_revenue":9999999.9,"last_activity_date":"2024-09-10T19:33:40.529Z","existence_level":"full","typed_custom_fields":{},"opportunity_rule_config_statuses":[],"opportunity_contact_roles":[{"id":"64a7ff0cc4dfae00013df1a5","role":"Decision Maker","contact":{"id":"64a7ff0cc4dfae00013df1a5","name":"Tim Zheng","first_name":"Tim","last_name":"Zheng"}}],"currency":{"name":"US Dollar","iso_code":"USD","symbol":"$"},"num_contacts":1,"account":{"id":"60afffecbff6de00a4b82be7","domain":"nasa.gov","name":"NASA - National Aeronautics and Space Administration","team_id":"6095a710bd01d100a506d4ac","organization_id":"55e16cfbf3e5bb66cf0026f3","account_stage_id":"6095a710bd01d100a506d4b9","source":"deployment","original_source":"deployment","creator_id":null,"owner_id":null,"created_at":"2021-05-27T20:24:12.644Z","phone":"+1 202-555-0117","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+12025550117","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Requested from Apollo","crm_record_url":null,"contact_emailer_campaign_ids":[],"contact_campaign_status_tally":{},"num_contacts":1,"last_activity_date":null}}]}},"Contact with no associated deals":{"value":{"opportunities":[]}}},"schema":{"type":"object","properties":{"opportunities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e09ea8e3cfcf01b2208ec7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":99999999,"default":0},"closed_date":{},"account_id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{"type":"boolean","example":false,"default":true},"name":{"type":"string","example":"Massive Space Deal"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"6095a710bd01d100a506d4bd"},"source":{"type":"string","example":"api"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"actual_close_date":{},"next_step":{},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"pipeline"},"deal_probability":{"type":"integer","example":10,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"654b989fcb2a5200010a90db"},"stage_updated_at":{"type":"string","example":"2024-09-10T19:33:40.529+00:00"},"next_step_last_updated_at":{},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":99999999,"default":0},"forecasted_revenue":{"type":"number","example":9999999.9,"default":0},"last_activity_date":{"type":"string","example":"2024-09-10T19:33:40.529Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"64a7ff0cc4dfae00013df1a5"},"role":{"type":"string","example":"Decision Maker"},"contact":{"type":"object","properties":{"id":{"type":"string","example":"64a7ff0cc4dfae00013df1a5"},"name":{"type":"string","example":"Tim Zheng"},"first_name":{"type":"string","example":"Tim"},"last_name":{"type":"string","example":"Zheng"}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"num_contacts":{"type":"integer","example":1,"default":0},"account":{"type":"object","properties":{"id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"domain":{"type":"string","example":"nasa.gov"},"name":{"type":"string","example":"NASA - National Aeronautics and Space Administration"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"55e16cfbf3e5bb66cf0026f3"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"deployment"},"original_source":{"type":"string","example":"deployment"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-05-27T20:24:12.644Z"},"phone":{"type":"string","example":"+1 202-555-0117"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+12025550117"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Requested from Apollo"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"message":"The maximum number of api calls allowed for api/v1/contacts/{contact_id}/opportunities is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/{contact_id}/opportunities is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/search":{"post":{"summary":"Search for Contacts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the Search for Contacts endpoint to search for the contacts that have been added to your team's Apollo account.

This endpoint only returns contacts in the search results. To search for people in the Apollo database, call the People API Search endpoint.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.","tags":["Contacts"],"operationId":"search-for-contacts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"q_keywords":{"type":"string","description":"Add keywords to narrow the search of the contacts in your team's Apollo account. Keywords can include combinations of names, job titles, employers (company names), and email addresses. Examples: `tim zheng`; `senior research analyst`; `microsoft`"},"contact_stage_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for the contact stages that you want to include in your search results. If you add multiple contact stages, Apollo will include all contacts that match any of the stages, along with the other parameters, in the search results. Call the [List Contact Stages endpoint](https://docs.apollo.io/reference/list-contact-stages) to retrieve a list of all the contact stage IDs available in your Apollo account. Example: `6095a710bd01d100a506d4ae`"},"contact_label_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for the labels that you want to include in your search results. If you add multiple labels, Apollo will include all contacts connected to any of the labels, along with the other parameters, in the search results. Example: `['6095a710bd01d100a506d4ae']`"},"sort_by_field":{"type":"string","description":"Sort the matching contacts by 1 of the following options: \n- `contact_last_activity_date`: The most recent activity date recorded first.\n- `contact_email_last_opened_at`: The most recent email opened date first.\n- `contact_email_last_clicked_at`: The most recent email clicked first.\n- `contact_created_at`: The most recently created first.\n- `contact_updated_at`: The most recently updated first."},"sort_ascending":{"type":"boolean","default":false,"description":"Set to `true` to sort the matching contacts in ascending order. This parameter must be used with `sort_by_field`. Otherwise, the sorting logic is not applied. Example: `true`"},"per_page":{"type":"integer","format":"int32","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. Use the `page` parameter to search the different pages of data. Example: `10`"},"page":{"type":"integer","format":"int32","description":"The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the `per_page` parameter to make search results navigable and improve the performance of the endpoint. Example: `4`"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"contacts":[{"contact_roles":[],"id":"66e3726977d36c03f2c30afc","first_name":"Walt","last_name":"Whitman","name":"Walt Whitman","linkedin_url":null,"title":"Associate Writer","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"60affe7d6e270a00f5db6fe4","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":"5e66b6381e05b4008c8331b8","headline":null,"photo_url":null,"present_raw_address":null,"linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T22:59:53.423Z","emailer_campaign_ids":[],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":null,"account_id":"63f53afe4ceeca00016bdd2f","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":null,"merged_crm_ids":null,"updated_at":"2024-09-12T23:00:41.194Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":["68eec47ece3b0b000de4751f"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"wwhitman@apollo.io","email_from_customer":true,"typed_custom_fields":{},"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Created from API","twitter_url":null,"contact_campaign_statuses":[],"account":{"id":"63f53afe4ceeca00016bdd2f","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":"+1(202) 555-0114","linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io","domain":"apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":null,"source":"csv_import","original_source":"salesforce","creator_id":null,"owner_id":"66302798d03b9601c7934ec2","created_at":"2023-02-21T21:43:26.351Z","phone_status":"no_status","hubspot_id":"7","salesforce_id":null,"crm_owner_id":"11750983","parent_account_id":null,"sanitized_phone":"+12025550114","account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"664f9eef1fded70001e4983e","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"664f9eef1fded70001e4983e","key":"664f9eef1fded70001e4983e"}],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{},"custom_field_errors":{},"modality":"account","source_display_name":"Uploaded from CSV","crm_record_url":"https://samplecrm.pipedrive.com/organization/7"},"contact_emails":[],"organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","blog_url":null,"angellist_url":null,"linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/meetapollo/","facebook_url":"https://www.facebook.com/MeetApollo","primary_phone":{},"languages":[],"alexa_ranking":3514,"phone":null,"linkedin_uid":"18511550","founded_year":2015,"publicly_traded_symbol":null,"publicly_traded_exchange":null,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture","crunchbase_url":null,"primary_domain":"apollo.io"},"intent_strength":null,"show_intent":false,"phone_numbers":[],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":false,"email_domain_catchall":false,"contact_job_change_event":null}],"breadcrumbs":[{"label":"Contains Keywords","signal_field_name":"q_keywords","value":"Apollo.io","display_name":"Apollo.io"},{"label":"Contact Stage","signal_field_name":"contact_stage_ids","value":"6095a710bd01d100a506d4ae","display_name":"New"},{"label":"Contact Stage","signal_field_name":"contact_stage_ids","value":"66e34b81740c50074e3d1bd4","display_name":"[Deleted Stage]"}],"partial_results_only":false,"has_join":false,"disable_eu_prospecting":false,"partial_results_limit":10000,"pagination":{"page":1,"per_page":2,"total_entries":178,"total_pages":89},"num_fetch_result":null}}},"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"contact_roles":{"type":"array"},"id":{"type":"string","example":"66e3726977d36c03f2c30afc"},"first_name":{"type":"string","example":"Walt"},"last_name":{"type":"string","example":"Whitman"},"name":{"type":"string","example":"Walt Whitman"},"linkedin_url":{},"title":{"type":"string","example":"Associate Writer"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4ae"},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"person_id":{},"email_needs_tickling":{},"organization_name":{"type":"string","example":"Apollo.io"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"headline":{},"photo_url":{},"present_raw_address":{},"linkedin_uid":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"salesforce_id":{},"salesforce_lead_id":{},"salesforce_contact_id":{},"salesforce_account_id":{},"crm_owner_id":{},"created_at":{"type":"string","example":"2024-09-12T22:59:53.423Z"},"emailer_campaign_ids":{"type":"array"},"direct_dial_status":{},"direct_dial_enrichment_failed_at":{},"email_status":{"type":"string","example":"verified"},"email_source":{},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"last_activity_date":{},"hubspot_vid":{},"hubspot_company_id":{},"crm_id":{},"sanitized_phone":{},"merged_crm_ids":{},"updated_at":{"type":"string","example":"2024-09-12T23:00:41.194Z"},"queued_for_crm_push":{"type":"boolean","example":false,"default":true},"suggested_from_rule_engine_config_id":{},"email_unsubscribed":{},"label_ids":{"type":"array"},"has_pending_email_arcgate_request":{"type":"boolean","example":false,"default":true},"has_email_arcgate_request":{"type":"boolean","example":false,"default":true},"existence_level":{"type":"string","example":"full"},"email":{"type":"string","example":"wwhitman@apollo.io"},"email_from_customer":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"crm_record_url":{},"email_status_unavailable_reason":{},"email_true_status":{"type":"string","example":"User Managed"},"updated_email_true_status":{"type":"boolean","example":true,"default":true},"contact_rule_config_statuses":{"type":"array"},"source_display_name":{"type":"string","example":"Created from API"},"twitter_url":{},"contact_campaign_statuses":{"type":"array","description":"Array of campaign statuses for the contact, showing their participation in various email sequences","items":{"type":"object","description":"Contact campaign status object representing the contact's current state in a specific email sequence","properties":{"id":{"type":"string","description":"Unique identifier for this contact campaign status record","example":"68782af181c7f0002159df25"},"emailer_campaign_id":{"type":"string","description":"ID of the email sequence (emailer campaign) this status belongs to","example":"66e9e215ece19801b219997f"},"send_email_from_user_id":{"type":"string","description":"ID of the user who is sending emails for this contact in the sequence","example":"66302798d03b9601c7934ebf"},"inactive_reason":{"type":"string","nullable":true,"description":"Reason why the contact is inactive in this sequence, if applicable","example":"Sequence inactive"},"status":{"type":"string","description":"Current status of the contact in this email sequence","enum":["active","failed","paused","finished"],"example":"paused"},"added_at":{"type":"string","format":"date-time","description":"Timestamp when the contact was added to this sequence","example":"2025-07-16T22:42:57.372+00:00"},"added_by_user_id":{"type":"string","description":"ID of the user who added this contact to the sequence","example":"60affe7d6e270a00f5db6fe4"},"finished_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the contact finished/completed the sequence","example":null},"paused_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the contact was paused in the sequence","example":null},"auto_unpause_at":{"type":"string","format":"date-time","nullable":true,"description":"Scheduled timestamp for automatically unpausing the contact","example":null},"send_email_from_email_address":{"type":"string","nullable":true,"description":"Specific email address used to send emails to this contact","example":"test.marcus.hale@apollomail.io"},"send_email_from_email_account_id":{"type":"string","description":"ID of the email account used to send emails to this contact","example":"6633baaece5fbd01c791d7ca"},"manually_set_unpause":{"type":"boolean","nullable":true,"description":"Whether the unpause was manually set by a user","example":null},"failure_reason":{"type":"string","nullable":true,"description":"Specific reason for failure if status is 'failed'","enum":["hard_bounced","spam_blocked","bounced","past_date_failure"],"example":null},"current_step_id":{"type":"string","nullable":true,"description":"ID of the current step in the sequence that the contact is on","example":null},"in_response_to_emailer_message_id":{"type":"string","nullable":true,"description":"ID of the emailer message this campaign status is in response to","example":null},"cc_emails":{"type":"array","nullable":true,"description":"Email addresses to CC when sending emails to this contact","items":{"type":"string"},"example":null},"bcc_emails":{"type":"array","nullable":true,"description":"Email addresses to BCC when sending emails to this contact","items":{"type":"string"},"example":null},"to_emails":{"type":"array","nullable":true,"description":"Additional email addresses to include in TO field when sending emails","items":{"type":"string"},"example":null},"current_step_position":{"type":"integer","nullable":true,"description":"Position number of the current step in the sequence (1-based indexing)","example":null}},"required":["id","emailer_campaign_id","send_email_from_user_id","status","added_at","added_by_user_id","send_email_from_email_account_id"]}},"account":{"type":"object","properties":{"id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{"type":"string","example":"+1(202) 555-0114"},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"},"domain":{"type":"string","example":"apollo.io"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"account_stage_id":{},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"salesforce"},"creator_id":{},"owner_id":{"type":"string","example":"66302798d03b9601c7934ec2"},"created_at":{"type":"string","example":"2023-02-21T21:43:26.351Z"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{"type":"string","example":"7"},"salesforce_id":{},"crm_owner_id":{"type":"string","example":"11750983"},"parent_account_id":{},"sanitized_phone":{"type":"string","example":"+12025550114"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"664f9eef1fded70001e4983e"},"created_at":{},"rule_action_config_id":{"type":"string","example":"65735e0ea63d2700faba5c6e"},"rule_config_id":{"type":"string","example":"65735e0ea63d2700faba5c6f"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"664f9eef1fded70001e4983e"},"key":{"type":"string","example":"664f9eef1fded70001e4983e"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6504905b21ba8e00a334eb0f"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{"type":"object","properties":{}},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{"type":"string","example":"https://samplecrm.pipedrive.com/organization/7"}}},"contact_emails":{"type":"array"},"organization":{"type":"object","properties":{"id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"name":{"type":"string","example":"Apollo.io"},"website_url":{"type":"string","example":"http://www.apollo.io"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/apolloio"},"twitter_url":{"type":"string","example":"https://twitter.com/meetapollo/"},"facebook_url":{"type":"string","example":"https://www.facebook.com/MeetApollo"},"primary_phone":{"type":"object","properties":{}},"languages":{"type":"array"},"alexa_ranking":{"type":"integer","example":3514,"default":0},"phone":{},"linkedin_uid":{"type":"string","example":"18511550"},"founded_year":{"type":"integer","example":2015,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/79049be00ff8e398b5935de8/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"apollo.io"}}},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"phone_numbers":{"type":"array"},"account_phone_note":{},"free_domain":{"type":"boolean","example":false,"default":true},"is_likely_to_engage":{"type":"boolean","example":false,"default":true},"email_domain_catchall":{"type":"boolean","example":false,"default":true},"contact_job_change_event":{}}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","example":"Contains Keywords"},"signal_field_name":{"type":"string","example":"q_keywords"},"value":{"type":"string","example":"Apollo.io"},"display_name":{"type":"string","example":"Apollo.io"}}}},"partial_results_only":{"type":"boolean","example":false,"default":true},"has_join":{"type":"boolean","example":false,"default":true},"disable_eu_prospecting":{"type":"boolean","example":false,"default":true},"partial_results_limit":{"type":"integer","example":10000,"default":0},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":2,"default":0},"total_entries":{"type":"integer","example":178,"default":0},"total_pages":{"type":"integer","example":89,"default":0}}},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/update_stages":{"post":{"summary":"Update Contact Stage for Multiple Contacts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact stages help you track progress on sales and marketing pipelines.

Use the Update Contact Stage for Multiple Contacts endpoint to update the contact stage for several contacts in your team's Apollo account.

To update more than the contact stage, such as job titles or contact details, use the Update a Contact endpoint instead.","tags":["Contacts"],"operationId":"update-contact-stage","parameters":[{"name":"contact_ids[]","in":"query","description":"The Apollo IDs for the contacts that you want to update.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"contact_stage_id","in":"query","description":"The Apollo ID for the contact stage to which you want to assign the contacts. Call the List Contact Stages endpoint to retrieve a list of all the contact stage IDs available in your Apollo account.

Example: `6095a710bd01d100a506d4af`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"contacts\": [\n {\n \"contact_roles\": [],\n \"id\": \"66e3726977d36c03f2c30afc\",\n \"first_name\": \"Gabriel\",\n \"last_name\": \"Stone\",\n \"name\": \"Gabriel Stone\",\n \"linkedin_url\": null,\n \"title\": \"Associate Writer\",\n \"contact_stage_id\": \"6095a710bd01d100a506d4b2\",\n \"owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"api\",\n \"original_source\": \"api\",\n \"organization_id\": \"5e66b6381e05b4008c8331b8\",\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": null,\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-09-12T22:59:53.423Z\",\n \"emailer_campaign_ids\": [],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": \"63f53afe4ceeca00016bdd2f\",\n \"last_activity_date\": null,\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": null,\n \"merged_crm_ids\": null,\n \"updated_at\": \"2024-09-13T00:12:09.547Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"gstone@apollo.io\",\n \"email_from_customer\": true,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"contact_rule_config_statuses\": [],\n \"source_display_name\": \"Created from API\",\n \"twitter_url\": null,\n \"contact_campaign_statuses\": [],\n \"contact_emails\": [],\n \"intent_strength\": null,\n \"show_intent\": false,\n \"phone_numbers\": [],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"is_likely_to_engage\": false,\n \"email_domain_catchall\": false\n },\n {\n \"contact_roles\": [],\n \"id\": \"66e370fbf5f5c003f0e1d0cf\",\n \"first_name\": \"Diana\",\n \"last_name\": \"Holloway\",\n \"name\": \"Diana Holloway\",\n \"linkedin_url\": null,\n \"title\": null,\n \"contact_stage_id\": \"6095a710bd01d100a506d4b2\",\n \"owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"api\",\n \"original_source\": \"api\",\n \"organization_id\": \"5e66b6381e05b4008c8331b8\",\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": null,\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-09-12T22:53:47.125Z\",\n \"emailer_campaign_ids\": [],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": \"63f53afe4ceeca00016bdd2f\",\n \"last_activity_date\": null,\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": null,\n \"merged_crm_ids\": null,\n \"updated_at\": \"2024-09-13T00:12:09.547Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"dholloway@apollo.io\",\n \"email_from_customer\": true,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"contact_rule_config_statuses\": [],\n \"source_display_name\": \"Created from API\",\n \"twitter_url\": null,\n \"contact_campaign_statuses\": [],\n \"contact_emails\": [],\n \"intent_strength\": null,\n \"show_intent\": false,\n \"phone_numbers\": [],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"is_likely_to_engage\": false,\n \"email_domain_catchall\": false\n },\n {\n \"contact_roles\": [],\n \"id\": \"66e379b5a385c703da3d729f\",\n \"first_name\": \"Carl\",\n \"last_name\": \"Whitfield\",\n \"name\": \"Carl Whitfield\",\n \"linkedin_url\": null,\n \"title\": \"Associate Writer\",\n \"contact_stage_id\": \"6095a710bd01d100a506d4b2\",\n \"owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"api\",\n \"original_source\": \"api\",\n \"organization_id\": \"5e66b6381e05b4008c8331b8\",\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": null,\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-09-12T23:31:01.293Z\",\n \"emailer_campaign_ids\": [],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": \"63f53afe4ceeca00016bdd2f\",\n \"last_activity_date\": null,\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": null,\n \"merged_crm_ids\": null,\n \"updated_at\": \"2024-09-13T00:12:09.547Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"cwhitfield@apollo.io\",\n \"email_from_customer\": true,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"contact_rule_config_statuses\": [],\n \"source_display_name\": \"Created from API\",\n \"twitter_url\": null,\n \"contact_campaign_statuses\": [],\n \"contact_emails\": [],\n \"intent_strength\": null,\n \"show_intent\": false,\n \"phone_numbers\": [],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"is_likely_to_engage\": false,\n \"email_domain_catchall\": false\n }\n ]\n}"}},"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"contact_roles":{"type":"array"},"id":{"type":"string","example":"66e3726977d36c03f2c30afc"},"first_name":{"type":"string","example":"Walt"},"last_name":{"type":"string","example":"Whitman"},"name":{"type":"string","example":"Walt Whitman"},"linkedin_url":{},"title":{"type":"string","example":"Associate Writer"},"contact_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b2"},"owner_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"person_id":{},"email_needs_tickling":{},"organization_name":{"type":"string","example":"Apollo.io"},"source":{"type":"string","example":"api"},"original_source":{"type":"string","example":"api"},"organization_id":{"type":"string","example":"5e66b6381e05b4008c8331b8"},"headline":{},"photo_url":{},"present_raw_address":{},"linkedin_uid":{},"extrapolated_email_confidence":{"type":"number","nullable":true},"salesforce_id":{},"salesforce_lead_id":{},"salesforce_contact_id":{},"salesforce_account_id":{},"crm_owner_id":{},"created_at":{"type":"string","example":"2024-09-12T22:59:53.423Z"},"emailer_campaign_ids":{"type":"array"},"direct_dial_status":{},"direct_dial_enrichment_failed_at":{},"email_status":{"type":"string","example":"verified"},"email_source":{},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"last_activity_date":{},"hubspot_vid":{},"hubspot_company_id":{},"crm_id":{},"sanitized_phone":{},"merged_crm_ids":{},"updated_at":{"type":"string","example":"2024-09-13T00:12:09.547Z"},"queued_for_crm_push":{"type":"boolean","example":false,"default":true},"suggested_from_rule_engine_config_id":{},"email_unsubscribed":{},"label_ids":{"type":"array"},"has_pending_email_arcgate_request":{"type":"boolean","example":false,"default":true},"has_email_arcgate_request":{"type":"boolean","example":false,"default":true},"existence_level":{"type":"string","example":"full"},"email":{"type":"string","example":"wwhitman@apollo.io"},"email_from_customer":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"crm_record_url":{},"email_status_unavailable_reason":{},"email_true_status":{"type":"string","example":"User Managed"},"updated_email_true_status":{"type":"boolean","example":true,"default":true},"contact_rule_config_statuses":{"type":"array"},"source_display_name":{"type":"string","example":"Created from API"},"twitter_url":{},"contact_campaign_statuses":{"type":"array"},"contact_emails":{"type":"array"},"intent_strength":{},"show_intent":{"type":"boolean","example":false,"default":true},"phone_numbers":{"type":"array"},"account_phone_note":{},"free_domain":{"type":"boolean","example":false,"default":true},"is_likely_to_engage":{"type":"boolean","example":false,"default":true},"email_domain_catchall":{"type":"boolean","example":false,"default":true}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Result":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add contact IDs":{"value":"{\n \"error\": \"Required parameter 'contact_ids' missing\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Required parameter 'contact_ids' missing"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/update_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/update_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/update_owners":{"post":{"summary":"Update Contact Owner for Multiple Contacts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact owners manage specific contacts in Apollo.

Use the Update Contact Owner for Multiple Contacts endpoint to assign multiple contacts to a different user in your team's Apollo account.

To update more than the contact's owner, such as job titles or contact details, use the Update a Contact endpoint instead.","tags":["Contacts"],"operationId":"update-contact-ownership","parameters":[{"name":"contact_ids[]","in":"query","description":"The Apollo IDs for the contacts that you want assign to an owner.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"owner_id","in":"query","description":"The ID for the contact owner within your team's Apollo account. This user will be assigned ownership of the contacts.

Use the Get a List of Users endpoint endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"contacts\": [\n {\n \"id\": \"66e379b5a385c703da3d729f\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"crm_owner_id\": null\n },\n {\n \"id\": \"66e370fbf5f5c003f0e1d0cf\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"crm_owner_id\": null\n },\n {\n \"id\": \"66e3491845dae20d5a2015ff\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"crm_owner_id\": null\n }\n ]\n}"}},"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e379b5a385c703da3d729f"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"crm_owner_id":{}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Result":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Check contact IDs":{"value":"{\n \"error\": \"Required parameter 'contact_ids' missing\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Required parameter 'contact_ids' missing"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/update_owners is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/update_owners is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contacts/bulk_create":{"post":{"summary":"Bulk Create Contacts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the Bulk Create Contacts endpoint to create up to 100 contacts in a single API request. This endpoint supports intelligent deduplication and returns separated arrays for newly created and existing contacts.

Important: This endpoint creates new contacts but doesn't update existing ones (except for placeholder contacts from email imports). Existing contacts that match the criteria are returned in the existing_contacts array without modification.

To update existing contacts, use the Bulk Update Contacts endpoint.","tags":["Contacts"],"operationId":"bulk-create-contacts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contacts"],"properties":{"contacts":{"type":"array","description":"Array of contact objects to create (maximum 100 contacts per request)","maxItems":100,"items":{"type":"object","properties":{"first_name":{"type":"string","description":"Contact's first name","example":"John"},"last_name":{"type":"string","description":"Contact's last name","example":"Doe"},"email":{"type":"string","description":"Contact's email address","example":"john.doe@example.com"},"title":{"type":"string","description":"Contact's job title","example":"Senior Manager"},"primary_title":{"type":"string","description":"Primary job title (takes precedence over title)","example":"VP of Sales"},"organization_name":{"type":"string","description":"Company/organization name","example":"Acme Corporation"},"phone":{"type":"string","description":"Phone number","example":"+1-555-0135"},"present_raw_address":{"type":"string","description":"Physical address","example":"San Francisco, CA"},"linkedin_url":{"type":"string","description":"LinkedIn profile URL","example":"https://www.linkedin.com/in/john-doe-3f9a7c21"},"facebook_url":{"type":"string","description":"Facebook profile URL","example":"https://www.facebook.com/johndoe"},"twitter_url":{"type":"string","description":"Twitter profile URL","example":"https://twitter.com/johndoe"},"photo_url":{"type":"string","description":"Profile photo URL","example":"https://example.com/photo.jpg"},"account_id":{"type":"string","description":"Associated account ID","example":"507f1f77bcf86cd799439011"},"organization_id":{"type":"string","description":"Associated organization ID","example":"507f1f77bcf86cd799439012"},"contact_stage_id":{"type":"string","description":"Contact stage ID","example":"507f1f77bcf86cd799439014"},"salesforce_id":{"type":"string","description":"Salesforce ID for matching and deduplication","example":"003xx000004TmiQAAS"},"hubspot_id":{"type":"string","description":"HubSpot ID for matching and deduplication","example":"12345678"},"salesforce_lead_id":{"type":"string","description":"Salesforce Lead ID","example":"00Qxx000001abcDEFG"},"salesforce_contact_id":{"type":"string","description":"Salesforce Contact ID for matching","example":"003xx000004TmiQAAS"},"salesforce_account_id":{"type":"string","description":"Salesforce Account ID","example":"001pJNj9pix2idKsfj"},"outreach_id":{"type":"string","description":"Outreach.io ID","example":"98765"},"salesloft_id":{"type":"string","description":"SalesLoft ID","example":"54321"},"phone_status_cd":{"type":"string","description":"Phone validation status"},"typed_custom_fields":{"type":"object","description":"Custom field values as key-value pairs where key is the field_id and value is the field_value","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}},"contact_emails":{"type":"array","description":"Array of email objects with position","items":{"type":"object","properties":{"email":{"type":"string","example":"john.doe@example.com"},"position":{"type":"integer","example":0}}}},"phone_numbers":{"type":"array","description":"Array of phone number objects","items":{"type":"object","properties":{"raw_number":{"type":"string","example":"+1-555-0135"},"position":{"type":"integer","example":0}}}},"contact_role_type_ids":{"type":"array","description":"Array of contact role type IDs","items":{"type":"string"},"example":["507f1f77bcf86cd799439020"]}}}},"append_label_names":{"type":"array","description":"Array of label names to add to ALL contacts in this request","items":{"type":"string"},"example":["Hot Lead","Q1 2024"]},"owner_id":{"type":"string","description":"Owner user ID applied to all contacts in this batch. Defaults to current user if omitted. Returns 422 if the ID does not belong to the current team.","example":"507f1f77bcf86cd799439013"},"run_dedupe":{"type":"boolean","description":"Enable full deduplication across all sources. When false (default), creates duplicates for non-email_import sources and merges with email_import placeholders only. When true, returns existing contacts without modifying them (except email_import placeholders which are still merged). Matches by email, CRM IDs, or name + organization","default":false,"example":true}}},"examples":{"Basic Contact Creation":{"value":{"contacts":[{"first_name":"John","last_name":"Doe","email":"john.doe@example.com","title":"Senior Manager","organization_name":"Acme Corporation"},{"first_name":"Jane","last_name":"Smith","email":"jane.smith@example.com","title":"VP of Sales","organization_name":"TechStart Inc","linkedin_url":"https://www.linkedin.com/in/jane-smith-4c8e21a9"}]}},"With Full Deduplication (Returns Existing Without Updating)":{"value":{"contacts":[{"email":"existing@example.com","first_name":"New","last_name":"Name","title":"New Title"}],"run_dedupe":true}},"With CRM IDs (Returns Existing Without Updating)":{"value":{"contacts":[{"salesforce_contact_id":"003xx000004TmiQAAS","first_name":"John","last_name":"Doe","email":"john.doe@example.com","phone":"+1-555-0159"},{"hubspot_id":"12345678","first_name":"Jane","last_name":"Smith","email":"jane.smith@example.com"}]}},"With Custom Fields and Labels":{"value":{"contacts":[{"first_name":"Sarah","last_name":"Whitfield","email":"sarah.whitfield@example.com","title":"CTO","organization_name":"Enterprise Corp","contact_stage_id":"507f1f77bcf86cd799439014","typed_custom_fields":{"60c39ed82bd02f01154c470a":"2025-12-31","60c39ed82bd02f01154c470b":"High Priority"}}],"append_label_names":["VIP","Decision Maker"]}},"With Multiple Contact Details":{"value":{"contacts":[{"first_name":"Michael","last_name":"Brown","organization_name":"Tech Solutions","contact_emails":[{"email":"michael.brown@example.com","position":0},{"email":"mbrown@example.com","position":1}],"phone_numbers":[{"raw_number":"+1-555-0135","position":0},{"raw_number":"+1-555-0122","position":1}]}]}},"With Top-Level Owner Assignment":{"value":{"contacts":[{"first_name":"Alice","last_name":"Chen","email":"alice.chen@example.com","title":"Director of Engineering","organization_name":"CloudCo","account_id":"507f1f77bcf86cd799439011"},{"first_name":"Bob","last_name":"Lee","email":"bob.lee@example.com","title":"Head of Product","organization_name":"CloudCo","account_id":"507f1f77bcf86cd799439011"}],"owner_id":"507f1f77bcf86cd799439013"}}}}}},"responses":{"200":{"description":"200 - Successful bulk create operation","content":{"application/json":{"examples":{"Result":{"value":{"created_contacts":[{"id":"507f1f77bcf86cd799439011","first_name":"John","last_name":"Doe","email":"john.doe@example.com","title":"Senior Manager","organization_name":"Acme Corporation","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","contact_stage_id":"507f1f77bcf86cd799439014","created_at":"2025-10-16T18:30:00Z","updated_at":"2025-10-16T18:30:00Z"},{"id":"507f1f77bcf86cd799439017","first_name":"Jane","last_name":"Smith","email":"jane.smith@example.com","title":"VP of Sales","organization_name":"TechStart Inc","linkedin_url":"https://www.linkedin.com/in/jane-smith-4c8e21a9","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","created_at":"2025-10-16T18:30:00Z","updated_at":"2025-10-16T18:30:00Z"}],"existing_contacts":[{"id":"507f1f77bcf86cd799439015","first_name":"Original","last_name":"Name","email":"existing@example.com","title":"Original Title","team_id":"507f1f77bcf86cd799439012","owner_id":"507f1f77bcf86cd799439013","created_at":"2025-09-01T10:00:00Z","updated_at":"2025-09-15T14:30:00Z"}]}}},"schema":{"type":"object","properties":{"created_contacts":{"type":"array","description":"Array of newly created contacts","items":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID","example":"507f1f77bcf86cd799439011"},"first_name":{"type":"string","description":"Contact's first name","example":"John"},"last_name":{"type":"string","description":"Contact's last name","example":"Doe"},"email":{"type":"string","description":"Contact's email address","example":"john.doe@example.com"},"title":{"type":"string","description":"Contact's job title","example":"Senior Manager"},"organization_name":{"type":"string","description":"Company/organization name","example":"Acme Corporation"},"team_id":{"type":"string","description":"Team ID","example":"507f1f77bcf86cd799439012"},"owner_id":{"type":"string","description":"Contact owner ID","example":"507f1f77bcf86cd799439013"},"contact_stage_id":{"type":"string","description":"Contact stage ID","example":"507f1f77bcf86cd799439014"},"created_at":{"type":"string","format":"date-time","description":"Contact creation timestamp","example":"2025-10-16T18:30:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Contact last update timestamp","example":"2025-10-16T18:30:00Z"}}}},"existing_contacts":{"type":"array","description":"Array of existing contacts that matched deduplication criteria (returned without modification, except for email_import placeholders which may be merged)","items":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID","example":"507f1f77bcf86cd799439015"},"first_name":{"type":"string","description":"Contact's first name","example":"Original"},"last_name":{"type":"string","description":"Contact's last name","example":"Name"},"email":{"type":"string","description":"Contact's email address","example":"existing@example.com"},"title":{"type":"string","description":"Contact's job title","example":"Original Title"},"team_id":{"type":"string","description":"Team ID","example":"507f1f77bcf86cd799439012"},"owner_id":{"type":"string","description":"Contact owner ID","example":"507f1f77bcf86cd799439013"},"created_at":{"type":"string","format":"date-time","description":"Contact creation timestamp","example":"2025-09-01T10:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Contact last update timestamp","example":"2025-09-15T14:30:00Z"}}}}}}}}},"401":{"description":"401 - Unauthorized","content":{"text/plain":{"examples":{"Invalid API Key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422 - Unprocessable Entity","content":{"application/json":{"examples":{"Missing contact_attributes parameter":{"value":"{\n \"error\": \"Please provide an array of contact attributes in the \\\"contact_attributes\\\" parameter.\"\n}"},"Too many contacts":{"value":"{\n \"error\": \"Please limit your array to 100 contacts or fewer.\"\n}"},"Invalid contact_attributes parameter":{"value":"{\n \"error\": \"Please provide an array of contact attributes in the \\\"contact_attributes\\\" parameter.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Please provide an array of contact attributes in the \"contact_attributes\" parameter."}}}}}},"429":{"description":"429 - Too Many Requests","content":{"application/json":{"examples":{"Rate limit exceeded":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}},"500":{"description":"500 - Internal Server Error","content":{"application/json":{"examples":{"Server error":{"value":"{\n \"error\": \"An error occurred while creating contacts. Please try again.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"An error occurred while creating contacts. Please try again."}}}}}}},"deprecated":false}},"/contacts/bulk_update":{"post":{"summary":"Bulk Update Contacts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.

Use the Bulk Update Contacts endpoint to update multiple contacts in your team's Apollo account simultaneously.

This endpoint allows you to update common fields across multiple contacts efficiently, such as contact stages, owners, custom fields, and other contact attributes.

You can update up to 1000 contacts per request; requests with more than 1000 contacts are rejected with a 422 error. Requests of 100 or fewer contacts are processed synchronously and return the updated contacts immediately. Requests of 101 to 1000 contacts are processed asynchronously. You can also force asynchronous processing at any batch size by setting the async parameter to true.","tags":["Contacts"],"operationId":"bulk-update-contacts","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contact_ids":{"type":"array","description":"Array of contact IDs to update with the same values. Use this for applying the same updates to multiple contacts.","items":{"type":"string"},"example":["66e34b81740c50074e3d1bd4","66e370fbf5f5c003f0e1d0cf"]},"contact_attributes":{"type":"array","description":"Array of contact objects with individual updates. Use this for applying different updates to each contact.","items":{"type":"object","properties":{"id":{"type":"string","description":"The contact ID to update","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","description":"The contact's first name","example":"John"},"last_name":{"type":"string","description":"The contact's last name","example":"Doe"},"email":{"type":"string","description":"The contact's email address","example":"john.doe@example.com"},"title":{"type":"string","description":"The contact's job title","example":"Senior Manager"},"organization_name":{"type":"string","description":"The contact's organization name","example":"Example Corp"},"owner_id":{"type":"string","description":"The Apollo user ID to assign as owner","example":"66302798d03b9601c7934ebf"},"account_id":{"type":"string","description":"The Apollo account ID to associate with the contact","example":"63f53afe4ceeca00016bdd2f"},"present_raw_address":{"type":"string","description":"The contact's location","example":"San Francisco, CA"},"linkedin_url":{"type":"string","description":"The contact's LinkedIn profile URL","example":"https://www.linkedin.com/in/john-doe-3f9a7c21"},"typed_custom_fields":{"type":"object","description":"Custom field values as key-value pairs","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}},"required":["id"]}},"owner_id":{"type":"string","description":"When using contact_ids, apply this owner to all contacts","example":"66302798d03b9601c7934ebf"},"email":{"type":"string","description":"When using contact_ids, apply this email to all contacts","example":"updated@example.com"},"organization_name":{"type":"string","description":"When using contact_ids, apply this organization name to all contacts","example":"Updated Corp"},"title":{"type":"string","description":"When using contact_ids, apply this title to all contacts","example":"Updated Title"},"first_name":{"type":"string","description":"When using contact_ids, apply this first name to all contacts","example":"Updated"},"last_name":{"type":"string","description":"When using contact_ids, apply this last name to all contacts","example":"Name"},"account_id":{"type":"string","description":"When using contact_ids, apply this account ID to all contacts","example":"63f53afe4ceeca00016bdd2f"},"present_raw_address":{"type":"string","description":"When using contact_ids, apply this address to all contacts","example":"New York, NY"},"linkedin_url":{"type":"string","description":"When using contact_ids, apply this LinkedIn URL to all contacts","example":"https://www.linkedin.com/in/updated"},"typed_custom_fields":{"type":"object","description":"When using contact_ids, apply these custom fields to all contacts","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}},"async":{"type":"boolean","description":"Force asynchronous processing. Automatically enabled for >100 contacts.","example":false},"visible_entity_ids":{"type":"array","description":"Specific contact IDs to return in the response (for performance)","items":{"type":"string"},"example":["66e34b81740c50074e3d1bd4"]}},"anyOf":[{"required":["contact_ids"]},{"required":["contact_attributes"]}]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"summary":"Synchronous response for ≀100 contacts","value":"{\n \"contacts\": [\n {\n \"id\": \"66e34b81740c50074e3d1bd4\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"title\": \"Senior Manager\",\n \"organization_name\": \"Example Corp\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"account_id\": \"63f53afe4ceeca00016bdd2f\",\n \"present_raw_address\": \"San Francisco, CA\",\n \"linkedin_url\": \"https://www.linkedin.com/in/john-doe-3f9a7c21\",\n \"updated_at\": \"2024-09-12T10:30:00.000Z\"\n }\n ]\n}"},"Asynchronous-Update":{"summary":"Asynchronous response for >100 contacts or async=true","value":"{\n \"entity_progress_job\": {\n \"id\": \"66e34b81740c50074e3d1234\",\n \"job_type\": \"contact_bulk_update\",\n \"status\": \"pending\",\n \"entity_ids\": [\"66e34b81740c50074e3d1bd4\", \"66e370fbf5f5c003f0e1d0cf\"],\n \"created_at\": \"2024-09-12T10:30:00.000Z\",\n \"updated_at\": \"2024-09-12T10:30:00.000Z\"\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string","example":"john.doe@example.com"},"title":{"type":"string","example":"Senior Manager"},"organization_name":{"type":"string","example":"Example Corp"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"account_id":{"type":"string","example":"63f53afe4ceeca00016bdd2f"},"present_raw_address":{"type":"string","example":"San Francisco, CA"},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/in/john-doe-3f9a7c21"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-12T10:30:00.000Z"}}}}}},{"type":"object","properties":{"entity_progress_job":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1234"},"job_type":{"type":"string","example":"contact_bulk_update"},"status":{"type":"string","example":"pending"},"entity_ids":{"type":"array","items":{"type":"string"},"example":["66e34b81740c50074e3d1bd4","66e370fbf5f5c003f0e1d0cf"]},"created_at":{"type":"string","format":"date-time","example":"2024-09-12T10:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-12T10:30:00.000Z"}}}}}]}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Result":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Missing Parameters":{"summary":"Missing required parameters","value":"{\n \"error\": \"Please provide either contact_ids or contact_attributes\"\n}"},"Too Many Contacts":{"summary":"Exceeds maximum limit","value":"{\n \"error\": \"Please limit your array to fewer than 1000.\"\n}"},"Update Error":{"summary":"Validation or update error","value":"{\n \"error\": \"Validation failed\",\n \"error_details\": {\n \"contact_id\": \"66e34b81740c50074e3d1bd4\",\n \"field\": \"email\",\n \"message\": \"Invalid email format\"\n }\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Please provide either contact_ids or contact_attributes"},"error_details":{"type":"object","properties":{"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"field":{"type":"string","example":"email"},"message":{"type":"string","example":"Invalid email format"}}}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contacts/bulk_update is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contacts/bulk_update is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/contact_stages":{"get":{"summary":"List Contact Stages","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact stages help you track progress on sales and marketing pipelines.

Use the List Contact Stages endpoint to retrieve the IDs for the available contact stages in your team's Apollo account.

Contact stage IDs can be used to update individual contacts and update the contact stages for multiple contacts via Apollo API.","tags":["Contacts"],"operationId":"list-contact-stages","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"contact_stages\": [\n {\n \"id\": \"6095a710bd01d100a506d4ae\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"New\",\n \"name\": \"New\",\n \"display_order\": 0,\n \"ignore_trigger_override\": null,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4af\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Approaching\",\n \"name\": \"Approaching\",\n \"display_order\": 1,\n \"ignore_trigger_override\": null,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b0\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Replied\",\n \"name\": \"Replied\",\n \"display_order\": 2,\n \"ignore_trigger_override\": null,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b1\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Interested\",\n \"name\": \"Interested\",\n \"display_order\": 3,\n \"ignore_trigger_override\": true,\n \"category\": \"succeeded\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b2\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Not Interested\",\n \"name\": \"Not Interested\",\n \"display_order\": 4,\n \"ignore_trigger_override\": true,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Unresponsive\",\n \"name\": \"Unresponsive\",\n \"display_order\": 5,\n \"ignore_trigger_override\": null,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b4\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Do Not Contact\",\n \"name\": \"Do Not Contact\",\n \"display_order\": 6,\n \"ignore_trigger_override\": true,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b5\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Bad Data\",\n \"name\": \"Bad Data\",\n \"display_order\": 7,\n \"ignore_trigger_override\": null,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6095a710bd01d100a506d4b6\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Changed Job\",\n \"name\": \"Changed Job\",\n \"display_order\": 8,\n \"ignore_trigger_override\": true,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af746\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Open\",\n \"name\": \"Open\",\n \"display_order\": 9,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af748\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Open Deal\",\n \"name\": \"Open Deal\",\n \"display_order\": 10,\n \"ignore_trigger_override\": false,\n \"category\": \"succeeded\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"61b8e913e0f4d2012e3af74a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Unqualified\",\n \"name\": \"Unqualified\",\n \"display_order\": 11,\n \"ignore_trigger_override\": false,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"64a2fa8d825e3900c389c2ff\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Follow up in 3 months\",\n \"name\": \"Follow up in 3 months\",\n \"display_order\": 12,\n \"ignore_trigger_override\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"6579f9fca341aa02d09968ba\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"no showed meeting\",\n \"name\": \"no showed meeting\",\n \"display_order\": 13,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"659641e195a361043972c9cb\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Meeting No Show\",\n \"name\": \"Meeting No Show\",\n \"display_order\": 14,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"663e90de1763de0572f53c3e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Cold Call\",\n \"name\": \"Cold Call\",\n \"display_order\": 15,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"664fa2e6ebf116034859a1fb\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Customer\",\n \"name\": \"Customer\",\n \"display_order\": 16,\n \"ignore_trigger_override\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"664fa2e6ebf116034859a1fc\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Hot lead\",\n \"name\": \"Hot lead\",\n \"display_order\": 17,\n \"ignore_trigger_override\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"664fa2e6ebf116034859a1fd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Warm lead\",\n \"name\": \"Warm lead\",\n \"display_order\": 18,\n \"ignore_trigger_override\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"664fa2e6ebf116034859a1fe\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Cold lead\",\n \"name\": \"Cold lead\",\n \"display_order\": 19,\n \"ignore_trigger_override\": false,\n \"category\": null,\n \"is_meeting_set\": null\n },\n {\n \"id\": \"666080be9e3eb606ad37f40e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"In Progress\",\n \"name\": \"In Progress\",\n \"display_order\": 20,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"666080be9e3eb606ad37f40f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Attempted to Contact\",\n \"name\": \"Attempted to Contact\",\n \"display_order\": 21,\n \"ignore_trigger_override\": false,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"666080be9e3eb606ad37f410\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Connected\",\n \"name\": \"Connected\",\n \"display_order\": 22,\n \"ignore_trigger_override\": false,\n \"category\": \"in_progress\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"666080be9e3eb606ad37f411\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Bad Timing\",\n \"name\": \"Bad Timing\",\n \"display_order\": 23,\n \"ignore_trigger_override\": false,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n {\n \"id\": \"66ac07bf353f3a01b2e5f674\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"display_name\": \"Doesn't want to talk to me\",\n \"name\": \"Doesn't want to talk to me\",\n \"display_order\": 24,\n \"ignore_trigger_override\": false,\n \"category\": \"failed\",\n \"is_meeting_set\": null\n },\n ]\n}"}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/contact_stages/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/contact_stages/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/contact_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/contact_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/opportunities":{"post":{"summary":"Create Deal","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the Create Deal endpoint to create new deals for an Apollo account.

To update existing deals in your Apollo account, use the Update Deal endpoint instead.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Deals"],"operationId":"create-deal","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name the deal you are creating. This should be a human-readable name.

Example: `Massive Q3 Deal`"},"owner_id":{"type":"string","description":"The ID for the deal owner within your team's Apollo account.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"account_id":{"type":"string","description":"The ID for the account within your Apollo instance. This is the company that you are targeting as part of the deal being created.

Each company in the Apollo database is assigned a unique ID. To find IDs, call the Organization Search endpoint and identify the values for `organization_id`.

Example: `5e66b6381e05b4008c8331b8`"},"amount":{"type":"string","description":"The monetary value of the deal being created.

Do not enter commas or currency symbols for the value. The currency is automatically populated by the settings within your Apollo account. Commas are not accepted and result in the deal amount being left blank.

Example: `55123478` (results in a deal value of `$55,123,478` if the default currency is USD)"},"opportunity_stage_id":{"type":"string","description":"The ID for the deal stage within your team's Apollo account.

Each deal stage is assigned a unique ID. To find deal stage IDs, call the List Deal Stages endpoint and identify the value for `id` for each stage.

Example: `6095a710bd01d100a506d4bd`"},"closed_date":{"type":"string","format":"date","description":"The estimated close date for the deal. This can be a future or past date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`"},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"opportunity":{"id":"66e09ea8e3cfcf01b2208ec7","team_id":"6095a710bd01d100a506d4ac","owner_id":"66302798d03b9601c7934ebf","salesforce_owner_id":null,"amount":99999999,"closed_date":null,"account_id":"55e16cfbf3e5bb66cf0026f3","description":null,"is_closed":false,"is_won":false,"name":"Massive Space Deal","stage_name":null,"opportunity_stage_id":"6095a710bd01d100a506d4bd","source":"api","salesforce_id":null,"created_at":"2024-09-10T19:31:52.436Z","actual_close_date":null,"next_step":null,"next_step_date":null,"closed_lost_reason":null,"closed_won_reason":null,"forecast_category":"pipeline","deal_probability":10,"created_by_id":"60affe7d6e270a00f5db6fe4","current_solutions":null,"deal_source":null,"manually_updated_probability":null,"manually_updated_forecast":null,"crm_id":null,"crm_record_url":null,"crm_owner_id":null,"probability":null,"opportunity_pipeline_id":"654b989fcb2a5200010a90db","stage_updated_at":"2024-09-10T19:31:52.436+00:00","next_step_last_updated_at":null,"exchange_rate_code":"USD","exchange_rate_value":1,"amount_in_team_currency":99999999,"forecasted_revenue":9999999.9,"last_activity_date":"2024-09-10T19:31:52.436Z","existence_level":"none","opportunity_rule_config_statuses":[],"opportunity_contact_roles":[],"currency":{"name":"US Dollar","iso_code":"USD","symbol":"$"},"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"}}}}},"schema":{"type":"object","properties":{"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e09ea8e3cfcf01b2208ec7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":99999999,"default":0},"closed_date":{},"account_id":{"type":"string","example":"55e16cfbf3e5bb66cf0026f3"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{"type":"boolean","example":false,"default":true},"name":{"type":"string","example":"Massive Space Deal"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"6095a710bd01d100a506d4bd"},"source":{"type":"string","example":"api"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"actual_close_date":{},"next_step":{},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"pipeline"},"deal_probability":{"type":"integer","example":10,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"654b989fcb2a5200010a90db"},"stage_updated_at":{"type":"string","example":"2024-09-10T19:31:52.436+00:00"},"next_step_last_updated_at":{},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":99999999,"default":0},"forecasted_revenue":{"type":"number","example":9999999.9,"default":0},"last_activity_date":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"existence_level":{"type":"string","example":"none"},"typed_custom_fields":{"type":"object","properties":{}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array"},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"deals/api/v1/opportunities/create is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"deals/api/v1/opportunities/create is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Enter a deal name":{"value":"{\n \"error\": \"Name is required\"\n}"},"Check the entered ID":{"value":"{\n \"error\": \"Parameters misconfigured. 12345 is not a valid ID\"\n}"}},"schema":{"oneOf":[{"title":"Enter a deal name","type":"object","properties":{"error":{"type":"string","example":"Name is required"}}},{"title":"Check the entered ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. 12345 is not a valid ID"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/opportunities is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/opportunities is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/opportunities/search":{"get":{"summary":"List All Deals","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the List All Deals endpoint to retrieve every deal that has been created for your team's Apollo account.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Deals"],"operationId":"list-all-deals","parameters":[{"name":"sort_by_field","in":"query","description":"Sort the tasks by 1 of the following options: ","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"breadcrumbs\": [],\n \"opportunities\": [\n {\n \"id\": \"66e09ea8e3cfcf01b2208ec7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"salesforce_owner_id\": null,\n \"amount\": 9999999999,\n \"closed_date\": \"2026-10-15T00:00:00.000+00:00\",\n \"account_id\": \"60afffecbff6de00a4b82be7\",\n \"description\": null,\n \"is_closed\": false,\n \"is_won\": false,\n \"name\": \"Ridiculously Massive Space Deal\",\n \"stage_name\": null,\n \"opportunity_stage_id\": \"66bb94fbc1695c00017fba5f\",\n \"source\": \"api\",\n \"salesforce_id\": null,\n \"created_at\": \"2024-09-10T19:31:52.436Z\",\n \"actual_close_date\": null,\n \"next_step\": null,\n \"next_step_date\": null,\n \"closed_lost_reason\": null,\n \"closed_won_reason\": null,\n \"forecast_category\": \"pipeline\",\n \"deal_probability\": 25,\n \"created_by_id\": \"60affe7d6e270a00f5db6fe4\",\n \"current_solutions\": null,\n \"deal_source\": null,\n \"manually_updated_probability\": null,\n \"manually_updated_forecast\": null,\n \"crm_id\": null,\n \"crm_record_url\": null,\n \"crm_owner_id\": null,\n \"probability\": null,\n \"opportunity_pipeline_id\": null,\n \"stage_updated_at\": \"2024-09-10T21:50:18.113+00:00\",\n \"next_step_last_updated_at\": null,\n \"exchange_rate_code\": \"USD\",\n \"exchange_rate_value\": 1,\n \"amount_in_team_currency\": 9999999999,\n \"forecasted_revenue\": 2499999999.75,\n \"last_activity_date\": \"2024-09-10T21:50:18.113Z\",\n \"existence_level\": \"full\",\n \"typed_custom_fields\": {},\n \"opportunity_rule_config_statuses\": [],\n \"opportunity_contact_roles\": [],\n \"currency\": {\n \"name\": \"US Dollar\",\n \"iso_code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"account\": {\n \"id\": \"60afffecbff6de00a4b82be7\",\n \"name\": \"NASA - National Aeronautics and Space Administration\",\n \"website_url\": \"http://www.nasa.gov\",\n \"blog_url\": null,\n \"angellist_url\": null,\n \"linkedin_url\": \"http://www.linkedin.com/company/nasa\",\n \"twitter_url\": \"https://twitter.com/NASA\",\n \"facebook_url\": \"http://www.facebook.com/NASAJPL\",\n \"primary_phone\": {\n \"number\": \"+1 202-555-0117\",\n \"source\": \"Owler\",\n \"sanitized_number\": \"+12025550117\"\n },\n \"languages\": [\n \"English\"\n ],\n \"alexa_ranking\": 1751,\n \"phone\": \"+1 202-555-0117\",\n \"linkedin_uid\": \"2003\",\n \"founded_year\": 1958,\n \"publicly_traded_symbol\": null,\n \"publicly_traded_exchange\": \"nyse\",\n \"logo_url\": \"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/139afb7258561417c1d70d4c/picture\",\n \"crunchbase_url\": null,\n \"primary_domain\": \"nasa.gov\",\n \"sanitized_phone\": \"+12025550117\",\n \"domain\": \"nasa.gov\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"organization_id\": \"55e16cfbf3e5bb66cf0026f3\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b9\",\n \"source\": \"deployment\",\n \"original_source\": \"deployment\",\n \"creator_id\": null,\n \"owner_id\": null,\n \"created_at\": \"2021-05-27T20:24:12.644Z\",\n \"phone_status\": \"no_status\",\n \"hubspot_id\": null,\n \"salesforce_id\": null,\n \"crm_owner_id\": null,\n \"parent_account_id\": null,\n \"account_playbook_statuses\": [],\n \"account_rule_config_statuses\": [\n {\n \"_id\": \"6466e8047759270001e53509\",\n \"created_at\": null,\n \"rule_action_config_id\": \"64650edd434f8f00a3b13938\",\n \"rule_config_id\": \"64650edd434f8f00a3b13939\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"6466e8047759270001e53509\",\n \"key\": \"6466e8047759270001e53509\"\n },\n {\n \"_id\": \"664f9e867bc0ad0001bd4230\",\n \"created_at\": null,\n \"rule_action_config_id\": \"65735e0ea63d2700faba5c6e\",\n \"rule_config_id\": \"65735e0ea63d2700faba5c6f\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"664f9e867bc0ad0001bd4230\",\n \"key\": \"664f9e867bc0ad0001bd4230\"\n }\n ],\n \"existence_level\": \"full\",\n \"label_ids\": [\n \"6466e8261e13be000133f25d\"\n ],\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"modality\": \"account\",\n \"source_display_name\": \"Requested from Apollo\",\n \"crm_record_url\": null,\n \"contact_emailer_campaign_ids\": [],\n \"contact_campaign_status_tally\": {},\n \"num_contacts\": 2,\n \"last_activity_date\": null\n }\n },\n {\n \"id\": \"66e0ab918c3aab02d0fc1484\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"salesforce_owner_id\": null,\n \"amount\": 3543535353,\n \"closed_date\": \"2025-01-24T00:00:00.000+00:00\",\n \"account_id\": \"6598a1ff9998b100011e62e8\",\n \"description\": null,\n \"is_closed\": false,\n \"is_won\": false,\n \"name\": \"Massive Big Deal\",\n \"stage_name\": null,\n \"opportunity_stage_id\": \"6095a710bd01d100a506d4bd\",\n \"source\": \"ui_form\",\n \"salesforce_id\": null,\n \"created_at\": \"2024-09-10T20:26:57.250Z\",\n \"actual_close_date\": null,\n \"next_step\": null,\n \"next_step_date\": null,\n \"closed_lost_reason\": null,\n \"closed_won_reason\": null,\n \"forecast_category\": \"pipeline\",\n \"deal_probability\": 10,\n \"created_by_id\": \"66302798d03b9601c7934ebf\",\n \"current_solutions\": null,\n \"deal_source\": null,\n \"manually_updated_probability\": null,\n \"manually_updated_forecast\": null,\n \"crm_id\": null,\n \"crm_record_url\": null,\n \"crm_owner_id\": null,\n \"probability\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"stage_updated_at\": \"2024-09-10T20:26:57.250+00:00\",\n \"next_step_last_updated_at\": null,\n \"exchange_rate_code\": \"USD\",\n \"exchange_rate_value\": 1,\n \"amount_in_team_currency\": 3543535353,\n \"forecasted_revenue\": 354353535.3,\n \"last_activity_date\": \"2024-09-10T20:27:04.893Z\",\n \"existence_level\": \"full\",\n \"typed_custom_fields\": {},\n \"opportunity_rule_config_statuses\": [],\n \"opportunity_contact_roles\": [],\n \"currency\": {\n \"name\": \"US Dollar\",\n \"iso_code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"account\": {\n \"id\": \"6598a1ff9998b100011e62e8\",\n \"name\": \"NVIDIA\",\n \"website_url\": \"http://www.nvidia.com\",\n \"blog_url\": null,\n \"angellist_url\": null,\n \"linkedin_url\": \"http://www.linkedin.com/company/nvidia\",\n \"twitter_url\": \"https://twitter.com/NVIDIANetworkng\",\n \"facebook_url\": \"https://www.facebook.com/NVIDIANetworking\",\n \"primary_phone\": {\n \"number\": \"+1 408-555-0142\",\n \"source\": \"Owler\",\n \"sanitized_number\": \"+14085550142\"\n },\n \"languages\": [],\n \"alexa_ranking\": 256,\n \"phone\": \"+1-408-555-0142\",\n \"linkedin_uid\": \"3608\",\n \"founded_year\": 1993,\n \"publicly_traded_symbol\": \"NVDA\",\n \"publicly_traded_exchange\": \"nasdaq\",\n \"logo_url\": \"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/07f1389988fefd17c25c9b4e/picture\",\n \"crunchbase_url\": null,\n \"primary_domain\": \"nvidia.com\",\n \"sanitized_phone\": \"+14085550142\",\n \"market_cap\": \"2921.5B\",\n \"domain\": \"nvidia.com\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"organization_id\": \"5f50a22da4560d00e3eddf31\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b7\",\n \"source\": \"deployment\",\n \"original_source\": \"deployment\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"owner_id\": null,\n \"created_at\": \"2024-01-06T00:42:39.874Z\",\n \"phone_status\": \"no_status\",\n \"hubspot_id\": null,\n \"salesforce_id\": null,\n \"crm_owner_id\": null,\n \"parent_account_id\": null,\n \"account_playbook_statuses\": [],\n \"account_rule_config_statuses\": [\n {\n \"_id\": \"664f9ea42bd8b70001d5125f\",\n \"created_at\": null,\n \"rule_action_config_id\": \"65735e0ea63d2700faba5c6e\",\n \"rule_config_id\": \"65735e0ea63d2700faba5c6f\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"664f9ea42bd8b70001d5125f\",\n \"key\": \"664f9ea42bd8b70001d5125f\"\n },\n {\n \"_id\": \"666599704a8c4e0001eb707a\",\n \"created_at\": null,\n \"rule_action_config_id\": \"64650edd434f8f00a3b13938\",\n \"rule_config_id\": \"64650edd434f8f00a3b13939\",\n \"status_cd\": \"failed\",\n \"updated_at\": null,\n \"id\": \"666599704a8c4e0001eb707a\",\n \"key\": \"666599704a8c4e0001eb707a\"\n }\n ],\n \"existence_level\": \"full\",\n \"label_ids\": [\n \"6466e8261e13be000133f25d\"\n ],\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"modality\": \"account\",\n \"source_display_name\": \"Requested from Apollo\",\n \"crm_record_url\": null,\n \"contact_emailer_campaign_ids\": [],\n \"contact_campaign_status_tally\": {},\n \"num_contacts\": 287,\n \"last_activity_date\": null\n }\n },\n {\n \"id\": \"64e4d9d3f1b93a00b6e9afcd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"owner_id\": \"60affe7d6e270a00f5db6fe4\",\n \"salesforce_owner_id\": null,\n \"amount\": 20000000,\n \"closed_date\": \"2024-01-31T00:00:00.000+00:00\",\n \"account_id\": \"62c5b05b09b10900cb37616a\",\n \"description\": null,\n \"is_closed\": false,\n \"is_won\": false,\n \"name\": \"Huge Deal\",\n \"stage_name\": null,\n \"opportunity_stage_id\": \"6153414bc0559d00016ce5fe\",\n \"source\": \"ui_form\",\n \"salesforce_id\": null,\n \"created_at\": \"2023-08-22T15:52:51.142Z\",\n \"actual_close_date\": null,\n \"next_step\": null,\n \"next_step_date\": null,\n \"closed_lost_reason\": null,\n \"closed_won_reason\": null,\n \"forecast_category\": \"pipeline\",\n \"deal_probability\": 10,\n \"created_by_id\": \"60affe7d6e270a00f5db6fe4\",\n \"current_solutions\": null,\n \"deal_source\": null,\n \"manually_updated_probability\": null,\n \"manually_updated_forecast\": null,\n \"crm_id\": null,\n \"crm_record_url\": null,\n \"crm_owner_id\": null,\n \"probability\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"stage_updated_at\": null,\n \"next_step_last_updated_at\": null,\n \"exchange_rate_code\": \"USD\",\n \"exchange_rate_value\": 1,\n \"amount_in_team_currency\": 20000000,\n \"forecasted_revenue\": 2000000,\n \"last_activity_date\": \"2023-11-09T02:06:28.283Z\",\n \"existence_level\": \"full\",\n \"typed_custom_fields\": {},\n \"opportunity_rule_config_statuses\": [],\n \"opportunity_contact_roles\": [],\n \"currency\": {\n \"name\": \"US Dollar\",\n \"iso_code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"account\": {\n \"id\": \"62c5b05b09b10900cb37616a\",\n \"name\": \"Amazon\",\n \"website_url\": \"http://www.amazon.com\",\n \"blog_url\": null,\n \"angellist_url\": null,\n \"linkedin_url\": \"http://www.linkedin.com/company/amazon\",\n \"twitter_url\": \"https://twitter.com/amazon\",\n \"facebook_url\": \"https://facebook.com/Amazon/\",\n \"primary_phone\": {\n \"number\": \"+1 206-555-0108\",\n \"source\": \"Owler\",\n \"sanitized_number\": \"+12065550108\"\n },\n \"languages\": [],\n \"alexa_ranking\": 18,\n \"phone\": \"+1 206-555-0108\",\n \"linkedin_uid\": \"1586\",\n \"founded_year\": 1994,\n \"publicly_traded_symbol\": \"AMZN\",\n \"publicly_traded_exchange\": \"nasdaq\",\n \"logo_url\": \"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/4b090fa1d16c355d80faff04/picture\",\n \"crunchbase_url\": null,\n \"primary_domain\": \"amazon.com\",\n \"sanitized_phone\": \"+12065550108\",\n \"market_cap\": \"1957.3B\",\n \"domain\": \"amazon.com\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"organization_id\": \"5f2a39cb77a7440112460cf5\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b7\",\n \"source\": \"deployment\",\n \"original_source\": \"deployment\",\n \"creator_id\": null,\n \"owner_id\": null,\n \"created_at\": \"2022-07-06T15:55:07.205Z\",\n \"phone_status\": \"no_status\",\n \"hubspot_id\": null,\n \"salesforce_id\": null,\n \"crm_owner_id\": null,\n \"parent_account_id\": null,\n \"account_playbook_statuses\": [\n {\n \"_id\": \"6360ba2b7eb0be00cbea1356\",\n \"added_by_id\": \"60affe7d6e270a00f5db6fe4\",\n \"added_on\": \"2022-11-01T06:18:19.578+00:00\",\n \"completed_step_ids\": [],\n \"created_at\": null,\n \"current_step_id\": \"6360b83b3f99e300a3d3d20e\",\n \"finished_reason_cd\": null,\n \"paused_reason_cd\": 0,\n \"playbook_id\": \"634832438e3ac500cc66265b\",\n \"position\": 1,\n \"status_cd\": \"paused\",\n \"updated_at\": null,\n \"id\": \"6360ba2b7eb0be00cbea1356\",\n \"key\": \"6360ba2b7eb0be00cbea1356\"\n }\n ],\n \"account_rule_config_statuses\": [\n {\n \"_id\": \"6466e8047759270001e53509\",\n \"created_at\": null,\n \"rule_action_config_id\": \"64650edd434f8f00a3b13938\",\n \"rule_config_id\": \"64650edd434f8f00a3b13939\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"6466e8047759270001e53509\",\n \"key\": \"6466e8047759270001e53509\"\n },\n {\n \"_id\": \"658118c6b2714c0001e4efe5\",\n \"created_at\": null,\n \"rule_action_config_id\": \"6580939a36272f01c6eda909\",\n \"rule_config_id\": \"6580939a36272f01c6eda90b\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"658118c6b2714c0001e4efe5\",\n \"key\": \"658118c6b2714c0001e4efe5\"\n },\n {\n \"_id\": \"662698e8b5d78e0007897f55\",\n \"created_at\": null,\n \"rule_action_config_id\": \"66268d54ce4494030093b962\",\n \"rule_config_id\": \"66268d54ce4494030093b963\",\n \"status_cd\": \"active\",\n \"updated_at\": null,\n \"id\": \"662698e8b5d78e0007897f55\",\n \"key\": \"662698e8b5d78e0007897f55\"\n },\n {\n \"_id\": \"664f9e7887829d0001373206\",\n \"created_at\": null,\n \"rule_action_config_id\": \"65735e0ea63d2700faba5c6e\",\n \"rule_config_id\": \"65735e0ea63d2700faba5c6f\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"664f9e7887829d0001373206\",\n \"key\": \"664f9e7887829d0001373206\"\n }\n ],\n \"existence_level\": \"full\",\n \"label_ids\": [\n \"6466e8261e13be000133f25d\"\n ],\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"modality\": \"account\",\n \"source_display_name\": \"Requested from Apollo\",\n \"crm_record_url\": null,\n \"contact_emailer_campaign_ids\": [],\n \"contact_campaign_status_tally\": {},\n \"num_contacts\": 11,\n \"last_activity_date\": null\n }\n }\n ],\n \"salesforce_users\": [],\n \"partial_results_only\": false,\n \"has_join\": false,\n \"disable_eu_prospecting\": false,\n \"partial_results_limit\": 10000,\n \"pagination\": {\n \"page\": 1,\n \"per_page\": 3,\n \"total_entries\": 35,\n \"total_pages\": 12\n },\n \"num_fetch_result\": null\n}"}},"schema":{"type":"object","properties":{"breadcrumbs":{"type":"array"},"opportunities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e09ea8e3cfcf01b2208ec7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":9999999999,"default":0},"closed_date":{"type":"string","example":"2026-10-15T00:00:00.000+00:00"},"account_id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{"type":"boolean","example":false,"default":true},"name":{"type":"string","example":"Ridiculously Massive Space Deal"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66bb94fbc1695c00017fba5f"},"source":{"type":"string","example":"api"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"actual_close_date":{},"next_step":{},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"pipeline"},"deal_probability":{"type":"integer","example":25,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{},"stage_updated_at":{"type":"string","example":"2024-09-10T21:50:18.113+00:00"},"next_step_last_updated_at":{},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":9999999999,"default":0},"forecasted_revenue":{"type":"number","example":2499999999.75,"default":0},"last_activity_date":{"type":"string","example":"2024-09-10T21:50:18.113Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array"},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"name":{"type":"string","example":"NASA - National Aeronautics and Space Administration"},"website_url":{"type":"string","example":"http://www.nasa.gov"},"blog_url":{},"angellist_url":{},"linkedin_url":{"type":"string","example":"http://www.linkedin.com/company/nasa"},"twitter_url":{"type":"string","example":"https://twitter.com/NASA"},"facebook_url":{"type":"string","example":"http://www.facebook.com/NASAJPL"},"primary_phone":{"type":"object","properties":{"number":{"type":"string","example":"+1 202-555-0117"},"source":{"type":"string","example":"Owler"},"sanitized_number":{"type":"string","example":"+12025550117"}}},"languages":{"type":"array","items":{"type":"string","example":"English"}},"alexa_ranking":{"type":"integer","example":1751,"default":0},"phone":{"type":"string","example":"+1 202-555-0117"},"linkedin_uid":{"type":"string","example":"2003"},"founded_year":{"type":"integer","example":1958,"default":0},"publicly_traded_symbol":{},"publicly_traded_exchange":{"type":"string","example":"nyse"},"logo_url":{"type":"string","example":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/139afb7258561417c1d70d4c/picture"},"crunchbase_url":{},"primary_domain":{"type":"string","example":"nasa.gov"},"sanitized_phone":{"type":"string","example":"+12025550117"},"domain":{"type":"string","example":"nasa.gov"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"55e16cfbf3e5bb66cf0026f3"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"deployment"},"original_source":{"type":"string","example":"deployment"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-05-27T20:24:12.644Z"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Requested from Apollo"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":2,"default":0},"last_activity_date":{}}}}}},"salesforce_users":{"type":"array"},"partial_results_only":{"type":"boolean","example":false,"default":true},"has_join":{"type":"boolean","example":false,"default":true},"disable_eu_prospecting":{"type":"boolean","example":false,"default":true},"partial_results_limit":{"type":"integer","example":10000,"default":0},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":3,"default":0},"total_entries":{"type":"integer","example":35,"default":0},"total_pages":{"type":"integer","example":12,"default":0}}},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Result":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"deals/api/v1/opportunities/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"oneOf":[{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"deals/api/v1/opportunities/search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}},{"title":"Check Apollo pricing plan","type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/opportunities/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/opportunities/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/opportunities/{opportunity_id}":{"get":{"summary":"View Deal","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the View Deal endpoint to retrieve complete details about a deal within your team's Apollo account.

Deal information can include the ID of the deal owner, the monetary value of the deal, the deal stage, and general details about the account.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Deals"],"operationId":"view-deal","parameters":[{"name":"opportunity_id","in":"path","description":"The ID for the deal you want to view.

Each deal in the Apollo database is assigned a unique ID. To find deal IDs, call the List All Deals endpoint and identify the value for `id` for the desired deal.

Example: `66e09ea8e3cfcf01b2208ec7`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"opportunity\": {\n \"id\": \"66e09ea8e3cfcf01b2208ec7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"owner_id\": \"66302798d03b9601c7934ebf\",\n \"salesforce_owner_id\": null,\n \"amount\": 99999999,\n \"closed_date\": null,\n \"account_id\": \"60afffecbff6de00a4b82be7\",\n \"description\": null,\n \"is_closed\": false,\n \"is_won\": false,\n \"name\": \"Massive Space Deal\",\n \"stage_name\": null,\n \"opportunity_stage_id\": \"6095a710bd01d100a506d4bd\",\n \"source\": \"api\",\n \"salesforce_id\": null,\n \"created_at\": \"2024-09-10T19:31:52.436Z\",\n \"actual_close_date\": null,\n \"next_step\": null,\n \"next_step_date\": null,\n \"closed_lost_reason\": null,\n \"closed_won_reason\": null,\n \"forecast_category\": \"pipeline\",\n \"deal_probability\": 10,\n \"created_by_id\": \"60affe7d6e270a00f5db6fe4\",\n \"current_solutions\": null,\n \"deal_source\": null,\n \"manually_updated_probability\": null,\n \"manually_updated_forecast\": null,\n \"crm_id\": null,\n \"crm_record_url\": null,\n \"crm_owner_id\": null,\n \"probability\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"stage_updated_at\": \"2024-09-10T19:33:40.529+00:00\",\n \"next_step_last_updated_at\": null,\n \"exchange_rate_code\": \"USD\",\n \"exchange_rate_value\": 1,\n \"amount_in_team_currency\": 99999999,\n \"forecasted_revenue\": 9999999.9,\n \"last_activity_date\": \"2024-09-10T19:33:40.529Z\",\n \"existence_level\": \"full\",\n \"typed_custom_fields\": {},\n \"opportunity_rule_config_statuses\": [],\n \"opportunity_contact_roles\": [],\n \"currency\": {\n \"name\": \"US Dollar\",\n \"iso_code\": \"USD\",\n \"symbol\": \"$\"\n },\n \"num_contacts\": 0,\n \"account\": {\n \"id\": \"60afffecbff6de00a4b82be7\",\n \"domain\": \"nasa.gov\",\n \"name\": \"NASA - National Aeronautics and Space Administration\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"organization_id\": \"55e16cfbf3e5bb66cf0026f3\",\n \"account_stage_id\": \"6095a710bd01d100a506d4b9\",\n \"source\": \"deployment\",\n \"original_source\": \"deployment\",\n \"creator_id\": null,\n \"owner_id\": null,\n \"created_at\": \"2021-05-27T20:24:12.644Z\",\n \"phone\": \"+1 202-555-0117\",\n \"phone_status\": \"no_status\",\n \"hubspot_id\": null,\n \"salesforce_id\": null,\n \"crm_owner_id\": null,\n \"parent_account_id\": null,\n \"linkedin_url\": null,\n \"sanitized_phone\": \"+12025550117\",\n \"account_playbook_statuses\": [],\n \"account_rule_config_statuses\": [\n {\n \"_id\": \"6466e8047759270001e53509\",\n \"created_at\": null,\n \"rule_action_config_id\": \"64650edd434f8f00a3b13938\",\n \"rule_config_id\": \"64650edd434f8f00a3b13939\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"6466e8047759270001e53509\",\n \"key\": \"6466e8047759270001e53509\"\n },\n {\n \"_id\": \"664f9e867bc0ad0001bd4230\",\n \"created_at\": null,\n \"rule_action_config_id\": \"65735e0ea63d2700faba5c6e\",\n \"rule_config_id\": \"65735e0ea63d2700faba5c6f\",\n \"status_cd\": \"completed\",\n \"updated_at\": null,\n \"id\": \"664f9e867bc0ad0001bd4230\",\n \"key\": \"664f9e867bc0ad0001bd4230\"\n }\n ],\n \"existence_level\": \"full\",\n \"label_ids\": [\n \"6466e8261e13be000133f25d\"\n ],\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"modality\": \"account\",\n \"source_display_name\": \"Requested from Apollo\",\n \"crm_record_url\": null,\n \"contact_emailer_campaign_ids\": [],\n \"contact_campaign_status_tally\": {},\n \"num_contacts\": 0,\n \"last_activity_date\": null\n }\n }\n}"}},"schema":{"type":"object","properties":{"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e09ea8e3cfcf01b2208ec7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":99999999,"default":0},"closed_date":{},"account_id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{"type":"boolean","example":false,"default":true},"name":{"type":"string","example":"Massive Space Deal"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"6095a710bd01d100a506d4bd"},"source":{"type":"string","example":"api"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"actual_close_date":{},"next_step":{},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"pipeline"},"deal_probability":{"type":"integer","example":10,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"654b989fcb2a5200010a90db"},"stage_updated_at":{"type":"string","example":"2024-09-10T19:33:40.529+00:00"},"next_step_last_updated_at":{},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":99999999,"default":0},"forecasted_revenue":{"type":"number","example":9999999.9,"default":0},"last_activity_date":{"type":"string","example":"2024-09-10T19:33:40.529Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array"},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"num_contacts":{"type":"integer","example":0,"default":0},"account":{"type":"object","properties":{"id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"domain":{"type":"string","example":"nasa.gov"},"name":{"type":"string","example":"NASA - National Aeronautics and Space Administration"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"55e16cfbf3e5bb66cf0026f3"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"deployment"},"original_source":{"type":"string","example":"deployment"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-05-27T20:24:12.644Z"},"phone":{"type":"string","example":"+1 202-555-0117"},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"sanitized_phone":{"type":"string","example":"+12025550117"},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Requested from Apollo"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"deals/api/v1/opportunities/show is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"deals/api/v1/opportunities/show is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Check the deal ID":{"value":"{\n \"status\": 404,\n \"error\": \"Not Found\"\n}"}},"schema":{"type":"object","properties":{"status":{"type":"integer","example":404,"default":0},"error":{"type":"string","example":"Not Found"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Add a deal ID":{"value":"{\n \"error\": \"Parameters misconfigured. opportunity_id is not a valid ID\"\n}"},"Do not have access to deal":{"value":"{\n \"error\": \"You are not authorized to view this page.\"\n}"}},"schema":{"oneOf":[{"title":"Add a deal ID","type":"object","properties":{"error":{"type":"string","example":"Parameters misconfigured. opportunity_id is not a valid ID"}}},{"title":"Do not have access to deal","type":"object","properties":{"error":{"type":"string","example":"You are not authorized to view this page."}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/opportunities/{opportunity_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/opportunities/{opportunity_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false},"patch":{"summary":"Update Deal","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the Update Deal endpoint to update the details of existing deals within your team's Apollo account.

To create new deals in your Apollo account, use the Create Deal endpoint instead.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Deals"],"operationId":"update-deal","parameters":[{"name":"opportunity_id","in":"path","description":"The ID for the deal you want to update.

Each deal in the Apollo database is assigned a unique ID. To find deal IDs, call the List All Deals endpoint and identify the value for `id` for the desired deal.

Example: `66e09ea8e3cfcf01b2208ec7`","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","description":"The ID for the deal owner within your team's Apollo account. Enter a different ID to update the owner of the deal.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"name":{"type":"string","description":"Update the name of the deal. This should be a human-readable name.

Example: `Massive Q3 Deal`"},"amount":{"type":"string","description":"The monetary value of the deal. Enter a different value to update the deal amount.

Do not enter commas or currency symbols for the value. The currency is automatically populated by the settings within your Apollo account. Commas are not accepted and result in the deal amount being left blank.

Example: `55123478` (results in a deal value of `$55,123,478` if the default currency is USD)"},"opportunity_stage_id":{"type":"string","description":"The ID for the deal stage within your team's Apollo account. Enter a different ID to update the deal stage.

Each deal stage is assigned a unique ID. To find deal stage IDs, call the List Deal Stages endpoint and identify the value for `id` for each stage.

Example: `6095a710bd01d100a506d4bd`"},"closed_date":{"type":"string","format":"date","description":"Update the estimated close date for the deal. This can be a future or past date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`"},"typed_custom_fields":{"type":"object","description":"Add information to custom fields in Apollo.

Your custom fields are unique to your team's Apollo account. This means that the examples in this documentation may not work for your testing purposes.

To utilize this parameter successfully, call the Get a List of All Custom Fields endpoint and identify the `id` value for the custom field, as well as the appropriate data type. For example, if a custom field accepts picklist entries, you need to pass the accompanying `id` value for the picklist entry that you want to use as the input value.

Example: When the Get a List of All Custom Fields endpoint returns an `id` of field: \n * `\"60c39ed82bd02f01154c470a\"` (datetime) \n \n\n then the value passed should be: \n\n `{\"60c39ed82bd02f01154c470a\": \"2025-08-07\"}`","additionalProperties":{"type":"string"},"example":{"60c39ed82bd02f01154c470a":"2025-08-07"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"opportunity":{"id":"66e09ea8e3cfcf01b2208ec7","team_id":"6095a710bd01d100a506d4ac","owner_id":"66302798d03b9601c7934ebf","salesforce_owner_id":null,"amount":999999999999,"closed_date":"2026-10-15T00:00:00.000+00:00","account_id":"60afffecbff6de00a4b82be7","description":null,"is_closed":false,"is_won":false,"name":"Ridiculously Massive Space Deal","stage_name":null,"opportunity_stage_id":"66bb94fbc1695c00017fba5f","source":"api","salesforce_id":null,"created_at":"2024-09-10T19:31:52.436Z","actual_close_date":null,"next_step":null,"next_step_date":null,"closed_lost_reason":null,"closed_won_reason":null,"forecast_category":"pipeline","deal_probability":25,"created_by_id":"60affe7d6e270a00f5db6fe4","current_solutions":null,"deal_source":null,"manually_updated_probability":null,"manually_updated_forecast":null,"crm_id":null,"crm_record_url":null,"crm_owner_id":null,"probability":null,"opportunity_pipeline_id":null,"stage_updated_at":"2024-09-10T21:31:53.640+00:00","next_step_last_updated_at":null,"exchange_rate_code":"USD","exchange_rate_value":1,"amount_in_team_currency":999999999999,"forecasted_revenue":249999999999.75,"last_activity_date":"2024-09-10T21:30:04.809Z","existence_level":"full","opportunity_rule_config_statuses":[],"opportunity_contact_roles":[],"currency":{"name":"US Dollar","iso_code":"USD","symbol":"$"},"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"}}}}},"schema":{"type":"object","properties":{"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e09ea8e3cfcf01b2208ec7"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":999999999999,"default":0},"closed_date":{"type":"string","example":"2026-10-15T00:00:00.000+00:00"},"account_id":{"type":"string","example":"60afffecbff6de00a4b82be7"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{"type":"boolean","example":false,"default":true},"name":{"type":"string","example":"Ridiculously Massive Space Deal"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66bb94fbc1695c00017fba5f"},"source":{"type":"string","example":"api"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-10T19:31:52.436Z"},"actual_close_date":{},"next_step":{},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"pipeline"},"deal_probability":{"type":"integer","example":25,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{},"stage_updated_at":{"type":"string","example":"2024-09-10T21:31:53.640+00:00"},"next_step_last_updated_at":{},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":999999999999,"default":0},"forecasted_revenue":{"type":"number","example":249999999999.75,"default":0},"last_activity_date":{"type":"string","example":"2024-09-10T21:30:04.809Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array"},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"deals/api/v1/opportunities/update is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"deals/api/v1/opportunities/update is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Check the deal ID":{"value":"{\n \"error\": \"Opportunity does not exist.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Opportunity does not exist."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/opportunities/{opportunity_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/opportunities/{opportunity_id} is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/opportunity_stages":{"get":{"summary":"List Deal Stages","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.

Use the List Deal Stages endpoint to retrieve information about every deal stage that's available in your team's Apollo account.

The `id` value for each deal stage can be used to set the stage when creating a deal or updating a deal via the Apollo API.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Deals"],"operationId":"list-deal-stages","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"opportunity_stages\": [\n {\n \"id\": \"6095a710bd01d100a506d4bd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualify\",\n \"display_order\": 0,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": \"Very first interaction with the AE on the account to determine their pain and fit for sales enablement in their business. This is the discovery phase where we ask questions to uncover need. This is more focused on their bsuiness and their workflow than our solution.\",\n \"salesforce_id\": \"01J8jXTZaxnljrDxwv\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66bb94fbc1695c00017fba5f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Meet & Present\",\n \"display_order\": 1,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 25,\n \"description\": null,\n \"salesforce_id\": \"01JqvNlB1DidltWun5\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": null,\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66bb94fbc1695c00017fba60\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Propose\",\n \"display_order\": 2,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 50,\n \"description\": null,\n \"salesforce_id\": \"01JPihF5IsBmhrBPcs\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": null,\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66bb94fbc1695c00017fba61\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Negotiate\",\n \"display_order\": 3,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 75,\n \"description\": null,\n \"salesforce_id\": \"01JRJRsXzbxjuBVqK1\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": null,\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 4,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": \"01Jth7NCQeSgkAM2TZ\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 5,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": \"01Jyg7och9mJ35AhLf\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"6153414bc0559d00016ce5fd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Prospecting\",\n \"display_order\": 6,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": null,\n \"salesforce_id\": \"01JxhZCvoQar5TgwoX\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce5fe\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualification\",\n \"display_order\": 7,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": null,\n \"salesforce_id\": \"01JRnbtEO24H0zPfvk\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce602\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Needs Analysis\",\n \"display_order\": 8,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": \"01JrhaqFgAQqadu5Z4\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce600\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Value Proposition\",\n \"display_order\": 9,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 50,\n \"description\": null,\n \"salesforce_id\": \"01JUVUaCnbatpVOesu\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce601\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Id. Decision Makers\",\n \"display_order\": 10,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": \"01JhGUWMlcArXkTfBQ\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce604\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Perception Analysis\",\n \"display_order\": 11,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 70,\n \"description\": null,\n \"salesforce_id\": \"01Jb33q1pf4bk0GDR8\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce5ff\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Proposal/Price Quote\",\n \"display_order\": 12,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 75,\n \"description\": null,\n \"salesforce_id\": \"01Jn27tQqVmJHNLcSc\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6153414bc0559d00016ce603\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Negotiation/Review\",\n \"display_order\": 13,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": \"01JvlPzLZvqeGQfeO7\",\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da684\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 14,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da685\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 15,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da686\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 16,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da687\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 17,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da688\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 18,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da689\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 19,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"66a7e9f49e70bf03f06da68a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 20,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66a7e9f49e70bf03f06da682\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d644e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Initial outreach\",\n \"display_order\": 21,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d644f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Needs assessment\",\n \"display_order\": 22,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 30,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6450\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Solution proposal\",\n \"display_order\": 23,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6451\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Solution presentation\",\n \"display_order\": 24,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6452\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Objection handling\",\n \"display_order\": 25,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6453\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Finalizing terms\",\n \"display_order\": 26,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6454\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed won\",\n \"display_order\": 27,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"6696b1d5159edf027a5d6455\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed lost\",\n \"display_order\": 28,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6696b1d5159edf027a5d644c\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6ccd\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 29,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6cce\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 30,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6ccf\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 31,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6cd0\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 32,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6cd1\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 33,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6cd2\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 34,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"668edd9c30f28303b85d6cd3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 35,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"668edd9c30f28303b85d6ccb\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e1\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 36,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e2\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 37,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 38,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e4\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 39,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e5\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 40,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e6\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 41,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"66758ba7f51546038c4067e7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 42,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"666885736b643603a2ec5c99\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 43,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Lead\",\n \"display_order\": 44,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 0,\n \"description\": \"A potential prospect who could be interested and a good fit to partner with.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf4\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Sales Qualified\",\n \"display_order\": 45,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": \"Determined that the prospect fits our ideal customer profile and to begin the sales process with.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 46,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9b\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 47,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf5\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Meeting Booked\",\n \"display_order\": 48,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": \"The initial meeting happened and it’s the discovery phase where we ask questions to uncover need. This is more focused on seeing if there is a mutual fit to partner and better understanding the prospect’s challenges.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9c\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 49,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf6\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Negotiation\",\n \"display_order\": 50,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": \"The prospect has narrowed their choices down to a few options (or chosen us). This is where we would get into a negotiation on closing the deal.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9d\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 51,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 52,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 70,\n \"description\": \"User has delivered a proposal to the prospect with pricing as well as any required documentation that we need them to sign.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf8\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 53,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": false,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 54,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"6668ad252e6e0803a154baf9\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 55,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": false,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"666885736b643603a2ec5c9f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 56,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a598\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 57,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a119415\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 58,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a599\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 59,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a119416\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 60,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a59a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 61,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a119417\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 62,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a119418\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 63,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a59b\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 64,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a119419\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 65,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a59c\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 66,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a59d\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 67,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c2149\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 68,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 69,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a11941a\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 70,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214c\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 71,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6656268b92b588034a11941b\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 72,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6656268b92b588034a119413\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"66607cea0b124603a2a7a59e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 73,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"66607ce90b124603a2a7a596\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214b\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 74,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"660abf69d8358b01ae3c214d\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 75,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Lead\",\n \"display_order\": 76,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 0,\n \"description\": \"A potential prospect who could be interested and a good fit to partner with.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c4\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Sales Qualified\",\n \"display_order\": 77,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 10,\n \"description\": \"Determined that the prospect fits our ideal customer profile and to begin the sales process with.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6579e60075a5170001f03d6c\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Appointment Scheduled\",\n \"display_order\": 78,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6579e60075a5170001f03d6d\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Qualified To Buy\",\n \"display_order\": 79,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c5\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Meeting Booked\",\n \"display_order\": 80,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": \"The initial meeting happened and it’s the discovery phase where we ask questions to uncover need. This is more focused on seeing if there is a mutual fit to partner and better understanding the prospect’s challenges.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c6\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Negotiation\",\n \"display_order\": 81,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": \"The prospect has narrowed their choices down to a few options (or chosen us). This is where we would get into a negotiation on closing the deal.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6579e60075a5170001f03d6e\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Presentation Scheduled\",\n \"display_order\": 82,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 60,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6579e60075a5170001f03d6f\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Decision Maker Bought-In\",\n \"display_order\": 83,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 80,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c7\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 84,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 70,\n \"description\": \"User has delivered a proposal to the prospect with pricing as well as any required documentation that we need them to sign.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": true,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6579e60075a5170001f03d70\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract Sent\",\n \"display_order\": 85,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c8\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 86,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": false,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"6579e60075a5170001f03d71\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 87,\n \"forecast_category_cd\": null,\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"65f9dd436c96a4043b9858c9\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 88,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"65f9dd436c96a4043b9858c1\",\n \"is_editable\": false,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"6579e60075a5170001f03d72\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 89,\n \"forecast_category_cd\": null,\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6579e5ff75a5170001f03d38\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4c2\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Won\",\n \"display_order\": 90,\n \"forecast_category_cd\": \"Closed\",\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 100,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4c3\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Closed Lost\",\n \"display_order\": 91,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": false,\n \"is_closed\": true,\n \"probability\": 0,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Closed/Lost\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4bc\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Omitted\",\n \"display_order\": 92,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 0,\n \"description\": \"Not a qualified opportunity to include in opportunity forecasting reports. This is a meeting to determine if there is an opportunity for us to engage in a sales cycle.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4be\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Educate\",\n \"display_order\": 93,\n \"forecast_category_cd\": \"Pipeline\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 20,\n \"description\": \"This is where we start to inform/ educate the buyer(s) on what sales enablement can do for their business by asking leading questions to start quantifying the need into busness impact and quantify the amount of time and money they waste on their current proces This is where we take the info we gathered from the discovery call and craft a specific pitch and customized demo based on their workflow and use case.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4bf\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Validate\",\n \"display_order\": 94,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 40,\n \"description\": \"When the prospect has seen our demo and now goes through the process of owning how us would be used inside their organization. This is their internal validation process and should be an opportunity for us to help them justify from a business perspective with information we've gathered in the discovery phase how it would help them save money or make money.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4c0\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Proposal\",\n \"display_order\": 95,\n \"forecast_category_cd\": \"Best Case\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 70,\n \"description\": \"The prospect has narrowed their choices down to a few options (or chosen us). This is where we would get into a negotiation on closing the deal. We will have delivered a proposal to them with pricing, users and start date as well as any required documentation that we need them to sign.\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6095a710bd01d100a506d4c1\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Commit\",\n \"display_order\": 96,\n \"forecast_category_cd\": \"Committed\",\n \"is_won\": false,\n \"is_closed\": false,\n \"probability\": 90,\n \"description\": \"Self-explanatory\",\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"654b989fcb2a5200010a90db\",\n \"is_editable\": null,\n \"type\": \"Open\"\n },\n {\n \"id\": \"6668adfa2e6e0803a154bd77\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"name\": \"Contract sent\",\n \"display_order\": 97,\n \"forecast_category_cd\": \"Omitted\",\n \"is_won\": true,\n \"is_closed\": true,\n \"probability\": 95,\n \"description\": null,\n \"salesforce_id\": null,\n \"is_meeting_set\": null,\n \"opportunity_pipeline_id\": \"6668ad252e6e0803a154baf1\",\n \"is_editable\": null,\n \"type\": \"Closed/Won\"\n }\n ]\n}"}},"schema":{"type":"object","properties":{"opportunity_stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"6095a710bd01d100a506d4bd"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"name":{"type":"string","example":"Qualify"},"display_order":{"type":"integer","example":0,"default":0},"forecast_category_cd":{"type":"string","example":"Pipeline"},"is_won":{"type":"boolean","example":false,"default":true},"is_closed":{"type":"boolean","example":false,"default":true},"probability":{"type":"integer","example":10,"default":0},"description":{"type":"string","example":"Very first interaction with the AE on the account to determine their pain and fit for sales enablement in their business. This is the discovery phase where we ask questions to uncover need. This is more focused on their bsuiness and their workflow than our solution."},"salesforce_id":{"type":"string","example":"01J8jXTZaxnljrDxwv"},"is_meeting_set":{},"opportunity_pipeline_id":{"type":"string","example":"654b989fcb2a5200010a90db"},"is_editable":{},"type":{"type":"string","example":"Open"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"deals/api/v1/opportunity_stages/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"deals/api/v1/opportunity_stages/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/opportunity_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/opportunity_stages is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/emailer_campaigns/search":{"post":{"summary":"Search for Sequences","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Search for Sequences endpoint to search for the sequences that have been created for your team's Apollo account.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"search-for-sequences","parameters":[{"name":"q_name","in":"query","description":"Add keywords to narrow the search of the sequences in your team's Apollo account.

Keywords should directly match at least part of a sequence's name. For example, searching the keyword `marketing` might return the result `NY Marketing Sequence`, but not `NY Marketer Conference 2025 attendees`.

This parameter only searches sequence names, not other sequence fields.

Example: `marketing conference attendees`","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`","schema":{"type":"string"}},{"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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"pagination":{"page":1,"per_page":5,"total_entries":1,"total_pages":1},"breadcrumbs":[{"label":"Name","signal_field_name":"q_name","value":"Copywriting Dublin","display_name":"Copywriting Dublin"}],"emailer_campaigns":[{"id":"66e9e215ece19801b219997f","name":"Target Copywriting Clients in Dublin","archived":false,"created_at":"2024-09-17T20:09:57.837Z","emailer_schedule_id":"6095a711bd01d100a506d52a","max_emails_per_day":null,"user_id":"66302798d03b9601c7934ebf","same_account_reply_policy_cd":null,"excluded_account_stage_ids":["6095a710bd01d100a506d4b8","6095a710bd01d100a506d4b9","6095a710bd01d100a506d4ba","6095a710bd01d100a506d4bb"],"excluded_contact_stage_ids":["6095a710bd01d100a506d4b5","6095a710bd01d100a506d4b4","6095a710bd01d100a506d4b0","6095a710bd01d100a506d4b1"],"contact_email_event_to_stage_mapping":{},"label_ids":["66e9e215ece19801b2199980","66e9e215ece19801b2199981","66e9e215ece19801b2199982"],"create_task_if_email_open":false,"email_open_trigger_task_threshold":3,"mark_finished_if_click":false,"active":false,"days_to_wait_before_mark_as_response":5,"starred_by_user_ids":["66302798d03b9601c7934ebf"],"mark_finished_if_reply":true,"mark_finished_if_interested":true,"mark_paused_if_ooo":true,"sequence_by_exact_daytime":null,"permissions":"team_can_use","last_used_at":null,"sequence_ruleset_id":"6095a711bd01d100a506d4e0","folder_id":null,"same_account_reply_delay_days":30,"is_performing_poorly":false,"num_contacts_email_status_extrapolated":0,"remind_ab_test_results":false,"ab_test_step_ids":[],"prioritized_by_user":null,"creation_type":"new","num_steps":3,"unique_scheduled":0,"unique_delivered":0,"unique_bounced":0,"unique_opened":0,"unique_hard_bounced":0,"unique_spam_blocked":0,"unique_replied":0,"unique_demoed":0,"unique_clicked":0,"unique_unsubscribed":0,"bounce_rate":0,"hard_bounce_rate":0,"open_rate":0,"click_rate":0,"reply_rate":0,"spam_block_rate":0,"opt_out_rate":0,"demo_rate":0,"loaded_stats":true,"cc_emails":"","bcc_emails":"","underperforming_touches_count":0}],"num_fetch_result":null}}},"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":5,"default":0},"total_entries":{"type":"integer","example":1,"default":0},"total_pages":{"type":"integer","example":1,"default":0}}},"breadcrumbs":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","example":"Name"},"signal_field_name":{"type":"string","example":"q_name"},"value":{"type":"string","example":"Copywriting Dublin"},"display_name":{"type":"string","example":"Copywriting Dublin"}}}},"emailer_campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e9e215ece19801b219997f"},"name":{"type":"string","example":"Target Copywriting Clients in Dublin"},"archived":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2024-09-17T20:09:57.837Z"},"emailer_schedule_id":{"type":"string","example":"6095a711bd01d100a506d52a"},"max_emails_per_day":{},"user_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"same_account_reply_policy_cd":{},"excluded_account_stage_ids":{"type":"array","items":{"type":"string","example":"6095a710bd01d100a506d4b8"}},"excluded_contact_stage_ids":{"type":"array","items":{"type":"string","example":"6095a710bd01d100a506d4b5"}},"contact_email_event_to_stage_mapping":{"type":"object","properties":{}},"label_ids":{"type":"array","items":{"type":"string","example":"66e9e215ece19801b2199980"}},"create_task_if_email_open":{"type":"boolean","example":false,"default":true},"email_open_trigger_task_threshold":{"type":"integer","example":3,"default":0},"mark_finished_if_click":{"type":"boolean","example":false,"default":true},"active":{"type":"boolean","example":false,"default":true},"days_to_wait_before_mark_as_response":{"type":"integer","example":5,"default":0},"starred_by_user_ids":{"type":"array","items":{"type":"string","example":"66302798d03b9601c7934ebf"}},"mark_finished_if_reply":{"type":"boolean","example":true,"default":true},"mark_finished_if_interested":{"type":"boolean","example":true,"default":true},"mark_paused_if_ooo":{"type":"boolean","example":true,"default":true},"sequence_by_exact_daytime":{},"permissions":{"type":"string","example":"team_can_use"},"last_used_at":{},"sequence_ruleset_id":{"type":"string","example":"6095a711bd01d100a506d4e0"},"folder_id":{},"same_account_reply_delay_days":{"type":"integer","example":30,"default":0},"is_performing_poorly":{"type":"boolean","example":false,"default":true},"num_contacts_email_status_extrapolated":{"type":"integer","example":0,"default":0},"remind_ab_test_results":{"type":"boolean","example":false,"default":true},"ab_test_step_ids":{"type":"array"},"prioritized_by_user":{},"creation_type":{"type":"string","example":"new"},"num_steps":{"type":"integer","example":3,"default":0},"unique_scheduled":{"type":"integer","example":0,"default":0},"unique_delivered":{"type":"integer","example":0,"default":0},"unique_bounced":{"type":"integer","example":0,"default":0},"unique_opened":{"type":"integer","example":0,"default":0},"unique_hard_bounced":{"type":"integer","example":0,"default":0},"unique_spam_blocked":{"type":"integer","example":0,"default":0},"unique_replied":{"type":"integer","example":0,"default":0},"unique_demoed":{"type":"integer","example":0,"default":0},"unique_clicked":{"type":"integer","example":0,"default":0},"unique_unsubscribed":{"type":"integer","example":0,"default":0},"bounce_rate":{"type":"integer","example":0,"default":0},"hard_bounce_rate":{"type":"integer","example":0,"default":0},"open_rate":{"type":"integer","example":0,"default":0},"click_rate":{"type":"integer","example":0,"default":0},"reply_rate":{"type":"integer","example":0,"default":0},"spam_block_rate":{"type":"integer","example":0,"default":0},"opt_out_rate":{"type":"integer","example":0,"default":0},"demo_rate":{"type":"integer","example":0,"default":0},"loaded_stats":{"type":"boolean","example":true,"default":true},"cc_emails":{"type":"string","example":""},"bcc_emails":{"type":"string","example":""},"underperforming_touches_count":{"type":"integer","example":0,"default":0}}}},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/emailer_campaigns/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"oneOf":[{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/emailer_campaigns/search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}},{"title":"Check Apollo pricing plan","type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/emailer_campaigns/{sequence_id}/add_contact_ids":{"post":{"summary":"Add Contacts to a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Add Contacts to a Sequence endpoint to add contacts to the existing sequences in your team's Apollo account.

A contact is a person that your team has explicitly added to your database. Only contacts can be added to sequences. To enrich a person's data, call the People Enrichment endpoint. Then, to add the person as a contact in your database, call the Create a Contact endpoint.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"add-contacts-to-sequence","parameters":[{"name":"sequence_id","in":"path","description":"The Apollo ID for the sequence to which you want to add contacts.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`","required":true,"schema":{"type":"string"}},{"name":"emailer_campaign_id","in":"query","description":"The same ID as the `sequence_id`.

Example: `66e9e215ece19801b219997f`","required":true,"schema":{"type":"string"}},{"name":"contact_ids[]","in":"query","description":"The Apollo IDs for the contacts that you want to add to the sequence.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`

Note: Either `contact_ids[]` or `label_names[]` must be provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"label_names[]","in":"query","description":"Alternative to `contact_ids[]`. Array of label names to identify contacts to add to the sequence. Contacts with these labels will be added to the sequence.

Note: Either `contact_ids[]` or `label_names[]` must be provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"send_email_from_email_account_id","in":"query","description":"The Apollo ID(s) for the email account(s) used to send to contacts you add to the sequence. Accepts either one id as a string, or multiple ids as an array of strings (multi-mailbox / rotation). To find email account IDs, call the Get a List of Email Accounts endpoint and identify the `id` value for each email account.

Examples: `6633baaece5fbd01c791d7ca` (string) or `[\"6633baaece5fbd01c791d7ca\", \"6633baaece5fbd01c791d7cb\"]` (array).","required":true,"schema":{"oneOf":[{"type":"string","description":"Single email account ID."},{"type":"array","items":{"type":"string"},"minItems":1,"description":"One or more email account IDs."}]}},{"name":"send_email_from_email_address","in":"query","description":"Optional specific email address to send from within the email account.","required":false,"schema":{"type":"string"}},{"name":"sequence_no_email","in":"query","description":"Set to `true` if you want to add contacts to the sequence even if they do not have an email address.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sequence_unverified_email","in":"query","description":"Set to `true` if you want to add contacts to the sequence if they have an unverified email address.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sequence_job_change","in":"query","description":"Set to `true` if you want to add contacts to the sequence even if they have recently changed jobs.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sequence_active_in_other_campaigns","in":"query","description":"Set to `true` if you want to add contacts to the sequence even if they have been added to other sequences. This parameter does not differentiate between active and paused sequences.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sequence_finished_in_other_campaigns","in":"query","description":"Set to `true` if you want to add contacts to the sequence if they have been marked as `finished` in another sequence.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sequence_same_company_in_same_campaign","in":"query","description":"Set to `true` if you want to add contacts to the sequence even if other contacts from the same company are already in the sequence.","required":false,"schema":{"type":"boolean","default":false}},{"name":"contacts_without_ownership_permission","in":"query","description":"Set to `true` if you want to add contacts even if you don't have ownership permission for them.","required":false,"schema":{"type":"boolean","default":false}},{"name":"add_if_in_queue","in":"query","description":"Set to `true` if you want to add contacts even if they are currently in the queue for processing.","required":false,"schema":{"type":"boolean","default":false}},{"name":"contact_verification_skipped","in":"query","description":"Set to `true` if you want to skip contact verification during the addition process.","required":false,"schema":{"type":"boolean","default":false}},{"name":"user_id","in":"query","description":"The ID for the user in your team's Apollo account.

This is the user taking the action to add contacts to a sequence. When the sequence is updated, the activity log shows the user that added the contacts.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Initial status for added contacts. When set to `paused` along with `auto_unpause_at`, enables scheduled addition of contacts.","required":false,"schema":{"type":"string","enum":["active","paused"]}},{"name":"auto_unpause_at","in":"query","description":"DateTime when paused contacts should be automatically unpaused. Must be used with `status=paused`. Format: ISO 8601 datetime string.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"contacts":[{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Fyodor","last_name":"Dostoevsky","name":"Fyodor Dostoevsky","linkedin_url":null,"title":"Chief Writer","contact_stage_id":null,"owner_id":"67b307d00957c2000d08872b","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":null,"headline":null,"photo_url":null,"present_raw_address":"St. Petersburg, Russia","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":["66e9e215ece19801b219997f"],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"city":"Saint Petersburg","country":"Russia","state":"Saint Petersburg","email_status":"verified","email_source":null,"account_id":null,"last_activity_date":"2025-03-09T20:31:17.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550117","merged_crm_ids":null,"updated_at":"2025-05-23T13:38:25.109Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"fyodor.dostoevsky@apollo.io","email_from_customer":true,"typed_custom_fields":{},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"source_display_name":"Created from API","twitter_url":null,"facebook_url":null,"contact_campaign_statuses":[{"id":"68782af181c7f0002159df25","emailer_campaign_id":"66e9e215ece19801b219997f","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":"Sequence inactive","status":"paused","added_at":"2025-07-16T22:42:57.372+00:00","added_by_user_id":"60affe7d6e270a00f5db6fe4","finished_at":null,"paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":null,"current_step_id":null,"in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":null}],"contact_emails":[{"email_md5":"cf4604bbd3c12ca9e36e20aa0aefac29","email_sha256":"b5d981918efbd5a93eb10f834643a4277034f24e3b5cabc2631440c7ade49cf8","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"fyodor.dostoevsky@apollo.io","free_domain":false,"source":"User Managed","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":null,"email_true_status":"User Managed","email_status_unavailable_reason":null}],"time_zone":"Asia/Krasnoyarsk","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"555-555-0117","sanitized_number":"+15555550117","type":"work_direct","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"User Managed","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false}],"skipped_contact_ids":{"66e34b81740c50074e3d1bd5":"contact_not_found"},"emailer_campaign":{"id":"66e9e215ece19801b219997f","name":"Target Copywriting Clients in Dublin","archived":true,"created_at":"2024-09-17T20:09:57.837Z","emailer_schedule_id":"6095a711bd01d100a506d52a","max_emails_per_day":null,"user_id":"66302798d03b9601c7934ebf","active":false,"loaded_stats":true},"emailer_steps":[{"id":"66e9e232ece19801b21999a4","emailer_campaign_id":"66e9e215ece19801b219997f","position":1,"wait_time":4,"type":"auto_email","wait_mode":"hour"}],"emailer_touches":[{"id":"66e9e232ece19801b21999a6","emailer_step_id":"66e9e232ece19801b21999a4","emailer_template_id":"66e9e232ece19801b21999a5","status":"approved","type":"new_thread"}],"team":{"id":"6095a710bd01d100a506d4ac","sequences_finder_empty":false},"signals_hash":null}}},"schema":{"type":"object","properties":{"contacts":{"type":"array","description":"Array of contacts that were successfully added to the sequence","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contact"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"organization_name":{"type":"string","nullable":true},"linkedin_url":{"type":"string","nullable":true},"contact_stage_id":{"type":"string","nullable":true},"owner_id":{"type":"string","nullable":true},"creator_id":{"type":"string"},"person_id":{"type":"string","nullable":true},"organization_id":{"type":"string","nullable":true},"account_id":{"type":"string","nullable":true},"source":{"type":"string"},"original_source":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"emailer_campaign_ids":{"type":"array","items":{"type":"string"}},"email_status":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"sanitized_phone":{"type":"string","nullable":true},"time_zone":{"type":"string","nullable":true},"contact_campaign_statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"emailer_campaign_id":{"type":"string"},"status":{"type":"string"},"added_at":{"type":"string","format":"date-time"},"send_email_from_email_account_id":{"type":"string"},"send_email_from_email_address":{"type":"string","nullable":true},"inactive_reason":{"type":"string","nullable":true}}}},"contact_emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"email_status":{"type":"string"},"position":{"type":"integer"},"email_md5":{"type":"string"},"email_sha256":{"type":"string"},"free_domain":{"type":"boolean"},"source":{"type":"string"},"email_true_status":{"type":"string"}}}},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"raw_number":{"type":"string"},"sanitized_number":{"type":"string"},"type":{"type":"string"},"position":{"type":"integer"},"status":{"type":"string"},"source_name":{"type":"string"}}}},"label_ids":{"type":"array","items":{"type":"string"}},"typed_custom_fields":{"type":"object"},"free_domain":{"type":"boolean"},"email_domain_catchall":{"type":"boolean"}}}},"skipped_contact_ids":{"type":"object","description":"Hash mapping contact IDs to reasons why they were skipped during the addition process. Each key is a contact ID and each value is a reason code.","properties":{"":{"type":"string","description":"Reason why this contact was skipped","x-enumDescriptions":{"contact_not_found":"Contact ID was not found for the team","contacts_already_exists_in_current_campaign":"Contact is already a part of current sequence","contacts_active_in_other_campaigns":"Contact is active in other sequence","contacts_finished_in_other_campaigns":"Contact is finished in other sequence","contacts_without_email":"Contact does not have email","contacts_unverified_email":"Contact does not have verified email","contacts_with_job_change":"Contact has a pending job change event","contacts_in_same_company":"Contact from the same company is part of the current sequence (Including for completeness, but extremely rare - only for old users who had opted in for such feature)","contacts_without_ownership_permission":"User does not have permission to reach out to contact","contacts_in_pending_state":"Contact is already part of account queue (Rare for api only users - only applicable for users who are using account based workflows in apollo)","contacts_with_unverified_user_managed_email":"Contact has unverified user-managed email"}}}},"emailer_campaign":{"type":"object","description":"Complete emailer campaign object with statistics","properties":{"id":{"type":"string"},"name":{"type":"string"},"archived":{"type":"boolean"},"active":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"user_id":{"type":"string"},"emailer_schedule_id":{"type":"string","nullable":true},"max_emails_per_day":{"type":"integer","nullable":true},"same_account_reply_policy_cd":{"type":"string","nullable":true},"excluded_account_stage_ids":{"type":"array","items":{"type":"string"}},"excluded_contact_stage_ids":{"type":"array","items":{"type":"string"}},"label_ids":{"type":"array","items":{"type":"string"}},"permissions":{"type":"string"},"loaded_stats":{"type":"boolean"},"unique_scheduled":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"unique_delivered":{"type":"integer"},"unique_bounced":{"type":"integer"},"unique_opened":{"type":"integer"},"unique_replied":{"type":"integer"},"bounce_rate":{"type":"number"},"open_rate":{"type":"number"},"reply_rate":{"type":"number"},"contact_statuses":{"type":"object","properties":{"active":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"failed":{"type":"integer"},"paused":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"finished":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"bounced":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]}}},"sharing_permission":{"type":"object","properties":{"visibility":{"type":"string"},"access_type":{"type":"string"},"object_type":{"type":"string"},"object_id":{"type":"string"},"is_owner":{"type":"boolean"},"owner_id":{"type":"string"},"sharing_accesses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shared_by":{"type":"string"},"user_or_team_id":{"type":"string"},"user_or_team_type":{"type":"string"},"access_type":{"type":"string"},"object_id":{"type":"string"},"object_type":{"type":"string"}}}}}}}},"emailer_steps":{"type":"array","description":"Array of sequence steps","items":{"type":"object","properties":{"id":{"type":"string"},"emailer_campaign_id":{"type":"string"},"position":{"type":"integer"},"wait_time":{"type":"integer"},"type":{"type":"string","enum":["auto_email","call","action_item","manual_email"]},"wait_mode":{"type":"string","enum":["hour","day","week"]},"note":{"type":"string","nullable":true},"priority":{"type":"string","enum":["high","medium","low"],"nullable":true},"counts":{"type":"object","properties":{"active":{"type":"integer"},"paused":{"type":"integer"},"finished":{"type":"integer"},"bounced":{"type":"integer"}}},"unique_scheduled":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"unique_skipped":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"unique_completed":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]}}}},"emailer_touches":{"type":"array","description":"Array of email templates/touches for the sequence","items":{"type":"object","properties":{"id":{"type":"string"},"emailer_step_id":{"type":"string"},"emailer_template_id":{"type":"string"},"status":{"type":"string","enum":["approved","pending","draft"]},"type":{"type":"string","enum":["new_thread","reply"]},"include_signature":{"type":"boolean"},"has_personalized_opener":{"type":"boolean"},"template_type":{"type":"string"},"unique_scheduled":{"oneOf":[{"type":"integer"},{"type":"string","enum":["loading"]}]},"unique_delivered":{"type":"integer"},"unique_bounced":{"type":"integer"},"unique_opened":{"type":"integer"},"unique_replied":{"type":"integer"},"bounce_rate":{"type":"number","nullable":true},"open_rate":{"type":"number","nullable":true},"reply_rate":{"type":"number","nullable":true}}}},"team":{"type":"object","properties":{"id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"sequences_finder_empty":{"type":"boolean","example":false}}},"signals_hash":{"type":"object","description":"Optional signals data for play recommendations and analytics","nullable":true}},"required":["contacts","skipped_contact_ids","emailer_campaign","emailer_steps","emailer_touches","team"]}}}},"401":{"description":"Unauthorized - Invalid API key","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Invalid API Key":{"value":"Invalid access credentials."}}}}},"403":{"description":"Forbidden - Master API key required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"error_code":{"type":"string"}}},"examples":{"Master API Key Required":{"value":{"error":"api/v1/emailer_campaigns/add_contact_ids is not accessible with this api_key","error_code":"API_INACCESSIBLE"}}}}}},"422":{"description":"Unprocessable Entity - Validation errors","content":{"application/json":{"examples":{"Add contact IDs":{"value":"{\n \"error\": \"Please specify either contact_ids or label_names.\"\n}"},"Add IDs":{"value":"{\n \"error\": \"Please specify a emailer_campaign_id and send_email_from_email_account_id.\"\n}"},"Inactive Email Accounts":{"value":"{\n \"error\": \"These mailboxes are no longer active. test@example.com\"\n}"},"Aggregate Accounts Not Supported":{"value":"{\n \"error\": \"Aggregate accounts are not supported for this sequence. These are the aggregate accounts: 6633baaece5fbd01c791d7ca\"\n}"}},"schema":{"oneOf":[{"title":"Add contact IDs","type":"object","properties":{"error":{"type":"string","example":"Please specify either contact_ids or label_names."}}},{"title":"Add IDs","type":"object","properties":{"error":{"type":"string","example":"Please specify a emailer_campaign_id and send_email_from_email_account_id."}}},{"title":"Inactive Email Accounts","type":"object","properties":{"error":{"type":"string","example":"These mailboxes are no longer active. test@example.com"}}},{"title":"Aggregate Accounts Not Supported","type":"object","properties":{"error":{"type":"string","example":"Aggregate accounts are not supported for this sequence. These are the aggregate accounts: 6633baaece5fbd01c791d7ca"}}}]}}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/{sequence_id}/add_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/{sequence_id}/add_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}}},"/emailer_campaigns/remove_or_stop_contact_ids":{"post":{"summary":"Update Contact Status in a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Update Contact Status in a Sequence endpoint to either mark contacts as having `finished` a sequence, or to remove them from a sequence entirely.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"update-contact-status-sequence","parameters":[{"name":"emailer_campaign_ids[]","in":"query","description":"The Apollo IDs for the sequences that you want to update. If you add multiple sequences, you will update the status of the contacts across the chosen sequences.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"contact_ids[]","in":"query","description":"The Apollo IDs for the contacts in the sequences. These are the contacts whose sequence status you want to update.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"mode","in":"query","description":"Choose 1 of the following options to update the sequence status of the contacts: ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":{"contacts":[{"contact_roles":[],"id":"66e34b81740c50074e3d1bd4","first_name":"Fyodor","last_name":"Dostoevsky","name":"Fyodor Dostoevsky","linkedin_url":null,"title":"Chief Writer","contact_stage_id":null,"owner_id":"67b307d00957c2000d08872b","creator_id":"60affe7d6e270a00f5db6fe4","person_id":null,"email_needs_tickling":null,"organization_name":"Apollo.io","source":"api","original_source":"api","organization_id":null,"headline":null,"photo_url":null,"present_raw_address":"St. Petersburg, Russia","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-12T20:13:53.207Z","emailer_campaign_ids":["66e9e215ece19801b219997f"],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"city":"Saint Petersburg","country":"Russia","state":"Saint Petersburg","email_status":"verified","email_source":null,"account_id":null,"last_activity_date":"2025-03-09T20:31:17.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550117","merged_crm_ids":null,"updated_at":"2025-05-23T13:38:25.109Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"fyodor.dostoevsky@apollo.io","email_from_customer":true,"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"User Managed","updated_email_true_status":true,"source_display_name":"Created from API","twitter_url":null,"facebook_url":null,"contact_campaign_statuses":[{"id":"68782af181c7f0002159df25","emailer_campaign_id":"66e9e215ece19801b219997f","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":"manually finished","status":"finished","added_at":"2025-07-16T22:42:57.372+00:00","added_by_user_id":"60affe7d6e270a00f5db6fe4","finished_at":"2025-07-16T22:45:21.237+00:00","paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":null,"current_step_id":null,"in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":null}],"contact_emails":[{"email_md5":"cf4604bbd3c12ca9e36e20aa0aefac29","email_sha256":"b5d981918efbd5a93eb10f834643a4277034f24e3b5cabc2631440c7ade49cf8","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"fyodor.dostoevsky@apollo.io","free_domain":false,"source":"User Managed","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":null,"email_true_status":"User Managed","email_status_unavailable_reason":null}],"time_zone":"Asia/Krasnoyarsk","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"555-555-0117","sanitized_number":"+15555550117","type":"work_direct","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"User Managed","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false,"typed_custom_fields":{"5b75f1c11dc2727d43ae3bb9":"test","5c4296857f799409361890ea":"test2"}}],"emailer_campaigns":[{"id":"66e9e215ece19801b219997f"}],"num_contacts":3,"contact_statuses":{"active":"loading","failed":0,"paused":"loading","finished":"loading","bounced":"loading","hard_bounced":"loading","spam_blocked":"loading","not_sent":"loading"},"emailer_steps":[{"id":"66e9e232ece19801b21999a4","emailer_campaign_id":"66e9e215ece19801b219997f","position":1,"wait_time":4,"type":"auto_email","wait_mode":"hour","note":null,"max_emails_per_day":null,"exact_datetime":null,"priority":null,"auto_skip_in_x_days":null,"counts":{"active":0,"paused":0,"finished":4,"bounced":0,"spam_blocked":0,"hard_bounced":0,"not_sent":0},"ab_test_details":{}},{"id":"66e9e250ece19802d1196d07","emailer_campaign_id":"66e9e215ece19801b219997f","position":2,"wait_time":3,"type":"call","wait_mode":"day","note":"","max_emails_per_day":null,"exact_datetime":null,"priority":"high","auto_skip_in_x_days":null,"counts":{"active":0,"paused":0,"finished":0,"bounced":0,"spam_blocked":0,"hard_bounced":0,"not_sent":0},"ab_test_details":{},"note_text":"","unique_scheduled":"loading","unique_skipped":"loading","unique_completed":"loading","outcomes":[]},{"id":"66e9e265ece198053919497b","emailer_campaign_id":"66e9e215ece19801b219997f","position":3,"wait_time":3,"type":"action_item","wait_mode":"day","note":"Decide the next step to take for contacts in the sequence.","max_emails_per_day":null,"exact_datetime":null,"priority":"medium","auto_skip_in_x_days":null,"counts":{"active":0,"paused":0,"finished":0,"bounced":0,"spam_blocked":0,"hard_bounced":0,"not_sent":0},"ab_test_details":{},"unique_scheduled":"loading","unique_skipped":"loading","unique_completed":"loading"}]},"summary":"OK"}},"schema":{"type":"object","properties":{"entity_progress_job":{"type":"object","properties":{"id":{"type":"string","example":"66e9fca8cc087302d18b83be"},"user_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"job_type":{"type":"string","example":"sequence_remove_stop_contacts"},"entity_ids":{"type":"array","items":{"type":"string","example":"66e9e9e21fbdad01b2b33bbd"}},"params":{"type":"object","properties":{"sequence_ids":{"type":"array","items":{"type":"string","example":"66e9e215ece19801b219997f"}},"mode":{"type":"string","example":"mark_as_finished"},"stop_reason":{},"api_key":{"type":"string","example":"dC3MrapHs3ktwPi1uy_-vp"},"access_token":{}}},"progress":{"type":"integer","example":0,"default":0},"batch_size":{"type":"integer","example":999,"default":0}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/emailer_campaigns/remove_or_stop_contact_ids is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/emailer_campaigns/remove_or_stop_contact_ids is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/remove_or_stop_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/remove_or_stop_contact_ids is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/sequences":{"post":{"summary":"Create a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Create a Sequence endpoint to create a new sequence in your team's Apollo account, including its steps and email templates.

To create a sequence with steps, add the `emailer_steps` array to the request body. Each email step (`auto_email`, `manual_email`) can include one or more `emailer_touches` (email variants); adding more than one touch to a step creates an A/B test, which requires a plan with A/B testing access.

To activate the sequence immediately after creation, set `active` to `true`. Email touches only send if their `status` is `approved`, and a touch can only be approved if its template has a non-empty body.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"create-sequence","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable name for the sequence.

Example: `Q3 Outbound Outreach`"},"permissions":{"type":"string","description":"Set who can use or view the sequence within your team. Choose 1 of the following options: "},"active":{"type":"boolean","description":"Set to `true` to activate the sequence immediately after creation so contacts added to it start receiving steps. If omitted or `false`, the sequence is created in an inactive state."},"emailer_schedule_id":{"type":"string","description":"The Apollo ID for the schedule that controls the days and times emails are sent. The schedule must belong to your team and must not be empty."},"user_id":{"type":"string","description":"The Apollo user ID for the owner of the sequence. Defaults to the user that owns the API key."},"label_names":{"type":"array","items":{"type":"string"},"description":"Add the names of lists (labels) to apply to the sequence. Labels that do not exist yet are created.

Example: `[\"Outbound\", \"Q3\"]`"},"folder_id":{"type":"string","description":"The Apollo ID for the folder in which to place the sequence."},"sequence_by_exact_daytime":{"type":"boolean","description":"Set to `true` to schedule every step at an exact date and time (`exact_datetime` becomes required on each step) instead of using relative wait intervals (`wait_time`/`wait_mode`)."},"max_emails_per_day":{"type":"integer","description":"The maximum number of emails the sequence sends per day. Must not be negative."},"mark_finished_if_reply":{"type":"boolean","description":"Set to `true` to mark contacts as finished in the sequence when they reply to an email."},"mark_finished_if_click":{"type":"boolean","description":"Set to `true` to mark contacts as finished in the sequence when they click a link in an email."},"mark_finished_if_interested":{"type":"boolean","description":"Set to `true` to mark contacts as finished in the sequence when they are marked as interested."},"mark_paused_if_ooo":{"type":"boolean","description":"Set to `true` to pause contacts in the sequence when an out-of-office auto-reply is detected."},"days_to_wait_before_mark_as_response":{"type":"integer","description":"The number of days to wait before an incoming email is no longer treated as a response to the sequence."},"create_task_if_email_open":{"type":"boolean","description":"Set to `true` to automatically create a task when a contact opens an email a certain number of times. Use `email_open_trigger_task_threshold` to set the number of opens."},"email_open_trigger_task_threshold":{"type":"integer","description":"The number of email opens that triggers task creation when `create_task_if_email_open` is `true`."},"same_account_reply_delay_days":{"type":"integer","description":"The number of days to pause other contacts at the same account after a reply is received. The maximum value is `1000`."},"excluded_account_stage_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for account stages to exclude from the sequence. All IDs must belong to your team."},"excluded_contact_stage_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for contact stages to exclude from the sequence. All IDs must belong to your team."},"ignore_apollo_global_email_bounce_list":{"type":"boolean","description":"Set to `true` to send emails to contacts even if their email address is on Apollo's global bounce list."},"sequence_ruleset_id":{"type":"string","description":"The Apollo ID for an existing sequence ruleset to apply shared sequence settings."},"emailer_steps":{"type":"array","description":"The steps to create in the sequence. Steps run in the order they appear in this array; the first item becomes the first step. There is no separate ordering field on input.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of step. Choose 1 of the following options: Step types other than `auto_email` require a plan with access to basic task functions."},"wait_time":{"type":"integer","description":"How long to wait after the previous step before this step runs. Required (along with `wait_mode`) unless the sequence uses `sequence_by_exact_daytime`.

Example: `2`"},"wait_mode":{"type":"string","description":"The unit for `wait_time`. Choose 1 of the following options: `minute`, `hour`, `day`."},"exact_datetime":{"type":"string","description":"The exact date and time at which the step runs, in ISO 8601 format. Required for each step when `sequence_by_exact_daytime` is `true`; must be in the future and later than the datetimes of all previous steps."},"priority":{"type":"string","description":"The priority of the task created for the step. Choose 1 of the following options: `high`, `medium`, `low`. Not applicable to `auto_email` steps."},"note":{"type":"string","description":"A note describing the step (for example, call talking points or action item instructions)."},"max_emails_per_day":{"type":"integer","description":"The maximum number of emails to send per day for this step."},"auto_skip_in_x_days":{"type":"integer","description":"Automatically skip the task for this step if it is not completed within the given number of days."},"emailer_touches":{"type":"array","description":"The email variants for the step. Applies to `auto_email`, `manual_email`, `linkedin_step_message`, `linkedin_step_connect`, and `call` steps. Adding more than 1 touch to a step creates an A/B test, which requires a plan with A/B testing access.","items":{"type":"object","properties":{"type":{"type":"string","description":"How the email threads with earlier steps. Choose 1 of the following options: "},"status":{"type":"string","description":"The review status of the touch. Choose 1 of the following options: "},"include_signature":{"type":"boolean","description":"Set to `true` to append the sending user's email signature to the email."},"emailer_template":{"type":"object","description":"The email content for the touch. Provide `id` to update an existing template that your team owns, or omit `id` to create a new template.","properties":{"id":{"type":"string","description":"The Apollo ID for an existing email template to use and update."},"subject":{"type":"string","description":"The subject line for the email. Supports dynamic variables such as `{{first_name}}`. Leave empty on a `reply_to_thread` touch to reuse the thread's subject."},"body_html":{"type":"string","description":"The HTML body for the email. Supports dynamic variables such as `{{first_name}}`. The HTML is sanitized; unsafe tags and attributes are removed."}}},"attachment_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for attachments to include with the email."}}}}}}}}},"examples":{"Create and activate a 2-step sequence":{"value":{"name":"Q3 Outbound Outreach","permissions":"team_can_use","active":true,"emailer_schedule_id":"66e9e215ece19801b2199900","label_names":["Outbound"],"emailer_steps":[{"type":"auto_email","wait_time":0,"wait_mode":"minute","emailer_touches":[{"type":"new_thread","status":"approved","include_signature":true,"emailer_template":{"subject":"Quick question, {{first_name}}","body_html":"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

"}}]},{"type":"auto_email","wait_time":3,"wait_mode":"day","emailer_touches":[{"type":"reply_to_thread","status":"approved","include_signature":true,"emailer_template":{"subject":"","body_html":"

Hi {{first_name}}, just floating this back to the top of your inbox.

"}}]}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":{"emailer_campaign":{"id":"68b1f3a2e1d2c40001a23b45","name":"Q3 Outbound Outreach","description":null,"archived":false,"created_at":"2026-06-12T10:15:30.000Z","emailer_schedule_id":"66e9e215ece19801b2199900","max_emails_per_day":null,"user_id":"60affe7d6e270a00f5db6fe4","same_account_reply_policy_cd":null,"excluded_account_stage_ids":[],"excluded_contact_stage_ids":[],"contact_email_event_to_stage_mapping":{},"label_ids":["68b1f3a3e1d2c40001a23b50"],"create_task_if_email_open":null,"email_open_trigger_task_threshold":null,"mark_finished_if_click":null,"active":true,"days_to_wait_before_mark_as_response":null,"starred_by_user_ids":[],"mark_finished_if_reply":null,"mark_finished_if_interested":null,"mark_paused_if_ooo":null,"sequence_by_exact_daytime":null,"permissions":"team_can_use","last_used_at":null,"sequence_ruleset_id":null,"ignore_apollo_global_email_bounce_list":null,"folder_id":null,"same_account_reply_delay_days":null,"is_performing_poorly":false,"num_contacts_email_status_extrapolated":null,"remind_ab_test_results":null,"ab_test_step_ids":[],"prioritized_by_user":null,"creation_type":"new","object_owner_id":"60affe7d6e270a00f5db6fe4","dmp_ids":[],"content_center_type":null,"product_profile_ids":[],"status_reason":"manual_approve","auto_pause_warning_level":null,"auto_paused_at":null,"auto_pause_bounce_rate":null,"allowed_send_from_domains":[],"project_workspace_context":{},"num_steps":2,"unique_scheduled":"loading","unique_delivered":"loading","unique_bounced":"loading","unique_opened":"loading","unique_hard_bounced":"loading","unique_spam_blocked":"loading","unique_replied":"loading","unique_demoed":"loading","unique_clicked":"loading","unique_unsubscribed":"loading","unique_opened_unfiltered":"loading","unique_clicked_unfiltered":"loading","unique_delivered_open_tracked":"loading","unique_delivered_click_tracked":"loading","bounce_rate":"loading","open_rate":"loading","click_rate":"loading","reply_rate":"loading","spam_block_rate":"loading","opt_out_rate":"loading","demo_rate":"loading","loaded_stats":true,"contact_statuses":{"active":0,"failed":0,"paused":0,"finished":0,"bounced":0,"hard_bounced":0,"spam_blocked":0,"not_sent":0},"cc_emails":"","bcc_emails":"","underperforming_touches_count":0,"sharing_permission":{"visibility":"team","access_type":"can_use","object_type":"EmailerCampaign","object_id":"68b1f3a2e1d2c40001a23b45","is_owner":true,"owner_id":"60affe7d6e270a00f5db6fe4","sharing_accesses":[]},"auto_pause_enabled":false,"auto_pause_config":{"evaluation_window_days":7,"min_volume":200,"warning_threshold_pct":7,"auto_pause_threshold_pct":10}},"sharing_accesses":[],"emailer_steps":[{"id":"68b1f3a2e1d2c40001a23b46","emailer_campaign_id":"68b1f3a2e1d2c40001a23b45","position":1,"wait_time":0,"type":"auto_email","wait_mode":"minute","note":null,"max_emails_per_day":null,"exact_datetime":null,"priority":null,"auto_skip_in_x_days":null,"counts":{"active":0,"paused":0,"finished":0,"bounced":0,"spam_blocked":0,"hard_bounced":0,"not_sent":0},"ab_test_details":{}},{"id":"68b1f3a2e1d2c40001a23b47","emailer_campaign_id":"68b1f3a2e1d2c40001a23b45","position":2,"wait_time":3,"type":"auto_email","wait_mode":"day","note":null,"max_emails_per_day":null,"exact_datetime":null,"priority":null,"auto_skip_in_x_days":null,"counts":{"active":0,"paused":0,"finished":0,"bounced":0,"spam_blocked":0,"hard_bounced":0,"not_sent":0},"ab_test_details":{}}],"emailer_touches":[{"id":"68b1f3a2e1d2c40001a23b48","emailer_step_id":"68b1f3a2e1d2c40001a23b46","emailer_template_id":"68b1f3a2e1d2c40001a23b4a","status":"approved","type":"new_thread","include_signature":true,"has_personalized_opener":null,"personalized_opener_fallback_option":"send_without_opener","generic_personalized_opener":null,"template_type":null,"generation_options":[],"generation_tone":{},"content_center_type":null,"product_profile_ids":[],"composition_mode":null,"project_workspace_id":null,"unique_scheduled":"loading","unique_delivered":"loading","unique_delivered_open_tracked":"loading","unique_delivered_click_tracked":"loading","unique_bounced":"loading","unique_hard_bounced":"loading","unique_spam_blocked":"loading","unique_opened":"loading","unique_opened_unfiltered":"loading","unique_clicked":"loading","unique_clicked_unfiltered":"loading","unique_replied":"loading","unique_demoed":"loading","unique_unsubscribed":"loading","bounce_rate":"loading","hard_bounce_rate":"loading","spam_block_rate":"loading","open_rate":"loading","open_rate_unfiltered":"loading","open_rate_tracked":"loading","open_rate_unfiltered_tracked":"loading","click_rate":"loading","click_rate_unfiltered":"loading","click_rate_tracked":"loading","click_rate_unfiltered_tracked":"loading","reply_rate":"loading","demo_rate":"loading","opt_out_rate":"loading"},{"id":"68b1f3a2e1d2c40001a23b49","emailer_step_id":"68b1f3a2e1d2c40001a23b47","emailer_template_id":"68b1f3a2e1d2c40001a23b4b","status":"approved","type":"reply_to_thread","include_signature":true,"has_personalized_opener":null,"personalized_opener_fallback_option":"send_without_opener","generic_personalized_opener":null,"template_type":null,"generation_options":[],"generation_tone":{},"content_center_type":null,"product_profile_ids":[],"composition_mode":null,"project_workspace_id":null,"unique_scheduled":"loading","unique_delivered":"loading","unique_delivered_open_tracked":"loading","unique_delivered_click_tracked":"loading","unique_bounced":"loading","unique_hard_bounced":"loading","unique_spam_blocked":"loading","unique_opened":"loading","unique_opened_unfiltered":"loading","unique_clicked":"loading","unique_clicked_unfiltered":"loading","unique_replied":"loading","unique_demoed":"loading","unique_unsubscribed":"loading","bounce_rate":"loading","hard_bounce_rate":"loading","spam_block_rate":"loading","open_rate":"loading","open_rate_unfiltered":"loading","open_rate_tracked":"loading","open_rate_unfiltered_tracked":"loading","click_rate":"loading","click_rate_unfiltered":"loading","click_rate_tracked":"loading","click_rate_unfiltered_tracked":"loading","reply_rate":"loading","demo_rate":"loading","opt_out_rate":"loading"}],"emailer_templates":[{"id":"68b1f3a2e1d2c40001a23b4a","name":null,"user_id":"60affe7d6e270a00f5db6fe4","starred_by_user_ids":[],"subject":"Quick question, {{first_name}}","archived":null,"created_at":"2026-06-12T10:15:30.000Z","global":false,"body_text":null,"folder_id":null,"body_html":"

Hi {{first_name}},

I noticed {{company}} is growing quickly...

","creation_type":null,"prompt_template_id":null,"description":null,"highlights":null,"has_ai_variables":false,"label_ids":[],"prompt_id":null},{"id":"68b1f3a2e1d2c40001a23b4b","name":null,"user_id":"60affe7d6e270a00f5db6fe4","starred_by_user_ids":[],"subject":"","archived":null,"created_at":"2026-06-12T10:15:30.000Z","global":false,"body_text":null,"folder_id":null,"body_html":"

Hi {{first_name}}, just floating this back to the top of your inbox.

","creation_type":null,"prompt_template_id":null,"description":null,"highlights":null,"has_ai_variables":false,"label_ids":[],"prompt_id":null}],"attachments":[],"team":{"id":"5f2f4b5e9c1d4e0001b6c7d8","sequences_finder_empty":false}},"summary":"OK"}},"schema":{"type":"object","properties":{"emailer_campaign":{"type":"object","description":"The newly created sequence, including its settings, aggregate email stats (`loading` until computed), contact status counts, and sharing permissions.","properties":{"id":{"type":"string","example":"68b1f3a2e1d2c40001a23b45"},"name":{"type":"string","example":"Q3 Outbound Outreach"},"active":{"type":"boolean","example":true},"permissions":{"type":"string","example":"team_can_use"},"user_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"emailer_schedule_id":{"type":"string","example":"66e9e215ece19801b2199900"},"num_steps":{"type":"integer","example":2},"creation_type":{"type":"string","example":"new"},"created_at":{"type":"string","example":"2026-06-12T10:15:30.000Z"}}},"emailer_steps":{"type":"array","description":"The steps created in the sequence.","items":{"type":"object","properties":{"id":{"type":"string","example":"68b1f3a2e1d2c40001a23b46"},"emailer_campaign_id":{"type":"string","example":"68b1f3a2e1d2c40001a23b45"},"position":{"type":"integer","example":1},"type":{"type":"string","example":"auto_email"},"wait_time":{"type":"integer","example":3},"wait_mode":{"type":"string","example":"day"}}}},"emailer_touches":{"type":"array","description":"The email variants created for each step, with their review status and per-touch email stats.","items":{"type":"object","properties":{"id":{"type":"string","example":"68b1f3a2e1d2c40001a23b48"},"emailer_step_id":{"type":"string","example":"68b1f3a2e1d2c40001a23b46"},"emailer_template_id":{"type":"string","example":"68b1f3a2e1d2c40001a23b4a"},"status":{"type":"string","example":"approved"},"type":{"type":"string","example":"new_thread"}}}},"emailer_templates":{"type":"array","description":"The email templates created or updated for the sequence's touches.","items":{"type":"object","properties":{"id":{"type":"string","example":"68b1f3a2e1d2c40001a23b4a"},"subject":{"type":"string","example":"Quick question, {{first_name}}"},"body_html":{"type":"string","example":"

Hi {{first_name}},

"}}}},"attachments":{"type":"array","items":{"type":"object"}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/sequences/create is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/sequences/create is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Missing create permission":{"value":"{\n \"error\": \"You do not have the permission to create sequences.\"\n}"},"Sequence limit reached":{"value":"{\n \"error\": \"Your plan is limited to 2 sequences. Learn more about our paid plans. \"\n}"},"Step limit reached":{"value":"{\n \"error\": \"Your plan is limited to 5 sequence steps. Learn more about our paid plans.\"\n}"},"Approved touch with empty template":{"value":"{\n \"error\": \"Please make sure your template has content before turning it on.\"\n}"},"A/B testing not available on plan":{"value":"{\n \"error\": \"Your current plan does not allow A/B Testing.\",\n \"code\": \"ab_testing_limit\"\n}"},"Empty schedule":{"value":"{\n \"error\": \"The schedule you are trying to attach to this sequence is empty. You cannot attach an empty schedule to the sequence\"\n}"},"Missing wait time":{"value":"{\n \"error\": \"Wait time must not be empty\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"You do not have the permission to create sequences."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Concurrent request for the same team":{"value":"{\n \"error\": \"We are already processing the request for your sequence\"\n}"},"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/sequences/create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}}}}}},"deprecated":false}},"/sequences/{id}":{"put":{"summary":"Update a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Update a Sequence endpoint to update an existing sequence (emailer campaign) in your team's Apollo account.

You can update sequence-level settings, such as the name, active state, schedule, and sending limits, as well as the sequence's steps and the email touches within each step.

To turn a sequence on or off, set the `active` field. Passing `emailer_steps` will create, update, reorder, or remove steps and their touches based on the IDs you provide.

To create a new sequence instead, use the Create a Sequence endpoint.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"update-sequence","parameters":[{"name":"id","in":"path","description":"The Apollo ID for the sequence that you want to update.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e34b81740c50074e3d1bd4`","schema":{"type":"string"},"required":true}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Update the name of the sequence. Example: `New outbound sequence`"},"active":{"type":"boolean","description":"Turn the sequence on (`true`) or off (`false`). When set to `true`, Apollo resumes scheduling for the sequence; when set to `false`, pending work is paused."},"creation_type":{"type":"string","description":"The creation type for the sequence. A `draft` sequence is automatically promoted to `new` (or `ai_assistant`) when steps are added.","enum":["draft","new","ai_assistant"]},"permissions":{"type":"string","description":"Update who can access the sequence. Example: `team_can_use`"},"emailer_schedule_id":{"type":"string","description":"Attach a sending schedule to the sequence. Must reference a non-empty schedule that belongs to your team. Example: `6095a710bd01d100a506d4af`"},"label_names":{"type":"array","description":"Replace the labels (folders) this sequence belongs to. Passing new values will overwrite the existing labels.","items":{"type":"string"}},"max_emails_per_day":{"type":"integer","description":"Maximum number of emails that can be sent per day for this sequence."},"same_account_reply_delay_days":{"type":"integer","description":"Number of days to wait before contacting another person at the same account."},"cc_emails":{"type":"string","description":"Comma-separated list of email addresses to CC on emails sent from this sequence."},"bcc_emails":{"type":"string","description":"Comma-separated list of email addresses to BCC on emails sent from this sequence."},"emailer_steps":{"type":"array","description":"The ordered list of steps in the sequence. Include an `id` to update an existing step; omit it to create a new step. Steps that exist on the sequence but are not present in this array are removed.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Apollo ID of an existing step to update. Omit to create a new step."},"position":{"type":"integer","description":"The 1-based position of the step within the sequence. Example: `1`"},"type":{"type":"string","description":"The step type.","example":"auto_email"},"wait_mode":{"type":"string","description":"The unit used for the wait before this step runs. Example: `day`"},"wait_time":{"type":"integer","description":"How long to wait (in `wait_mode` units) before running this step. Example: `1`"},"auto_skip_in_x_days":{"type":"integer","description":"Automatically skip this step if it has not run within the given number of days."},"emailer_touches":{"type":"array","description":"The email touches that belong to this step. Include an `id` to update an existing touch; omit it to create a new touch.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Apollo ID of an existing touch to update. Omit to create a new touch."},"status":{"type":"string","description":"The review status of the touch. Set to `approved` to enable the touch (the template must have a non-empty body).","enum":["to_be_reviewed","approved"]},"attachment_ids":{"type":"array","description":"IDs of attachments to include with this touch.","items":{"type":"string"}},"emailer_template":{"type":"object","description":"The email template content for this touch.","properties":{"subject":{"type":"string","description":"The subject line of the email. Example: `Quick question, {{first_name}}`"},"body_html":{"type":"string","description":"The HTML body of the email. Example: `

Hi {{first_name}}

`"}}},"generation_options":{"type":"array","description":"AI generation options used to compose the touch content.","items":{"type":"object","properties":{"type":{"type":"string","example":"ai_full_email"},"additional_prompt":{"type":"string"},"signals":{"type":"array","items":{"type":"string"}},"field_name":{"type":"string","example":"AI Full Email df7fdbd8"}}}},"generation_tone":{"type":"object","description":"The tone to apply when generating the touch content with AI.","properties":{"tone_type":{"type":"string","example":"Direct"},"tone_sample":{"type":"string"}}}}}}}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"id":"66e34b81740c50074e3d1bd4","name":"first campaign","active":true,"archived":false,"created_at":"2024-09-12T20:13:53.207Z","updated_at":"2024-09-12T20:14:53.134Z","num_steps":1,"steps":[{"id":"66e361494acd1307386d4073","position":1,"step_type":"auto_email","wait_time":1,"wait_mode":"day","auto_skip_in_x_days":null}],"emailer_campaign":{"id":"66e34b81740c50074e3d1bd4","name":"first campaign","active":true},"emailer_steps":[{"id":"66e361494acd1307386d4073","position":1}],"emailer_touches":[{"id":"66e361494acd1307386d4074","status":"approved"}]}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"name":{"type":"string","example":"first campaign"},"active":{"type":"boolean","example":true},"archived":{"type":"boolean","example":false},"created_at":{"type":"string","example":"2024-09-12T20:13:53.207Z"},"updated_at":{"type":"string","example":"2024-09-12T20:14:53.134Z"},"num_steps":{"type":"integer","example":1},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e361494acd1307386d4073"},"position":{"type":"integer","example":1},"step_type":{"type":"string","example":"auto_email"},"wait_time":{"type":"integer","example":1},"wait_mode":{"type":"string","example":"day"},"auto_skip_in_x_days":{}}}},"emailer_campaign":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"name":{"type":"string","example":"first campaign"},"active":{"type":"boolean","example":true}}},"emailer_steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e361494acd1307386d4073"},"position":{"type":"integer","example":1}}}},"emailer_touches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e361494acd1307386d4074"},"status":{"type":"string","example":"approved"}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Sequence not found":{"value":{"error":"Record not found."}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Record not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Empty template body":{"value":{"error":"Please make sure your template has a non-empty body before turning it on."}},"Empty schedule":{"value":{"error":"The schedule you are trying to attach to this sequence is empty. You cannot attach an empty schedule to the sequence"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Please make sure your template has a non-empty body before turning it on."}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"error":"We are already processing the request for your sequence"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"We are already processing the request for your sequence"}}}}}}},"deprecated":false}},"/tasks":{"post":{"summary":"Create a Task","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Create a Task endpoint to create a single task in Apollo for you and your team. Tasks help track the upcoming actions you need to take, such as emailing or calling a contact.

This endpoint returns the created task object.

Apollo does not apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo will create a new task instead of updating the existing task.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Tasks"],"operationId":"create-a-task","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","contact_id","type","status","due_at"],"properties":{"user_id":{"type":"string","description":"The ID for the task owner within your team's Apollo account. This is the user that will take action on the contacts.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"contact_id":{"type":"string","description":"The Apollo ID for the contact that you want to be on the receiving end of the action.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`"},"type":{"type":"string","description":"Set the task to be 1 of the following task types. This enables the task owner to know the type of action they need to take. "},"priority":{"type":"string","description":"Assign a priority to the task you are creating: ","default":"medium"},"status":{"type":"string","description":"The status of the task being created. For future-facing tasks, you should use the `scheduled` status.

For tasks that are already completed, you can use `completed` or `skipped`.

Example: `scheduled`"},"due_at":{"type":"string","format":"date-time","description":"The full date and time when the task will be due.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a task due date that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifying in hours and minutes how much you want to offset GMT.

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00`"},"title":{"type":"string","description":"A title for the task. If omitted, Apollo will display an auto-generated title based on the task type and contact name.

Example: `Follow up on demo request`"},"note":{"type":"string","description":"Add a description for the task. This should be a human-readable message.

This parameter is not required, but it is recommended as it provides the task owner with more context on the action they need to take.

Example: `This contact expressed interest in the Sequences feature specifically. Be prepared to discuss.`"}}},"examples":{"Create a call task":{"value":{"user_id":"66302798d03b9601c7934ebf","contact_id":"66e34b81740c50074e3d1bd4","type":"call","priority":"high","status":"scheduled","due_at":"2025-02-15T10:00:00Z","title":"Follow-up call","note":"Discuss product demo results and next steps."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}}}}}},"examples":{"Result":{"value":{"task":{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234567","user_id":"66302798d03b9601c7934ebf","created_at":"2025-02-03T15:30:00.000Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd4","person_id":"66e34b81740c50074e3d1bd5","account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with John Smith","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","title":"VP of Sales","email":"john.smith@example.com","organization_name":"Example Corp","photo_url":null,"twitter_url":null,"github_url":null,"facebook_url":null,"account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","present_raw_address":"San Francisco, CA","city":"San Francisco","state":"California","country":"United States","email_status":"verified"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","domain":"example.com","team_id":"6095a710bd01d100a506d4ac","organization_id":"5fc93db64c38d300d6aa24e6","owner_id":"66302798d03b9601c7934ebf","created_at":"2021-09-01T15:34:04.371Z","phone":"+1 (555) 555-0164","phone_status":"no_status","linkedin_url":"https://www.linkedin.com/company/example-corp"}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/tasks is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Missing required fields":{"value":"{\n \"error\": \"type and user can not be blank\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"deprecated":false}},"/tasks/bulk_create":{"post":{"summary":"Bulk Create Tasks","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Bulk Create Tasks endpoint to create multiple tasks in a single API request. A separate task will be created for each contact provided.

This endpoint returns a `success` boolean and a `tasks` array containing the created tasks.

Apollo doesn't apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo creates a new task instead of updating the existing task.

For creating a single task, use the Create a Task endpoint instead.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Tasks"],"operationId":"bulk-create-tasks","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","contact_ids","type","status","due_at"],"properties":{"user_id":{"type":"string","description":"The ID for the task owner within your team's Apollo account. This is the user that will take action on the contacts.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`"},"contact_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs for the contacts that you want to be on the receiving end of the action.

If you add multiple contact IDs, individual tasks will be created for each of the contacts using the same task type, due date, and other details.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`"},"type":{"type":"string","description":"Set the task to be 1 of the following task types. This enables the task owner to know the type of action they need to take. "},"priority":{"type":"string","description":"Assign a priority to the task you are creating: ","default":"medium"},"status":{"type":"string","description":"The status of the task being created. For future-facing tasks, you should use the `scheduled` status.

For tasks that are already completed, you can use `completed` or `skipped`.

Example: `scheduled`"},"due_at":{"type":"string","format":"date-time","description":"The full date and time when the task will be due.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a task due date that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifying in hours and minutes how much you want to offset GMT.

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00`"},"note":{"type":"string","description":"Add a description for the task. This should be a human-readable message.

This parameter is not required, but it is recommended as it provides the task owner with more context on the action they need to take.

Example: `This contact expressed interest in the Sequences feature specifically. Be prepared to discuss.`"}}},"examples":{"Create call tasks for multiple contacts":{"value":{"user_id":"66302798d03b9601c7934ebf","contact_ids":["66e34b81740c50074e3d1bd4","66e34b81740c50074e3d1bd5","66e34b81740c50074e3d1bd6"],"type":"call","priority":"high","status":"scheduled","due_at":"2025-02-15T10:00:00Z","note":"Follow up on demo request."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"tasks":{"type":"array","items":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}}}}}}},"examples":{"Result":{"value":{"success":true,"tasks":[{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234567","user_id":"66302798d03b9601c7934ebf","created_at":"2025-02-03T15:30:00.000Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd4","person_id":"66e34b81740c50074e3d1bd5","account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with John Smith","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","title":"VP of Sales","email":"john.smith@example.com","organization_name":"Example Corp","photo_url":null,"twitter_url":null,"github_url":null,"facebook_url":null,"account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","present_raw_address":"San Francisco, CA","city":"San Francisco","state":"California","country":"United States","email_status":"verified"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","domain":"example.com","team_id":"6095a710bd01d100a506d4ac","organization_id":"5fc93db64c38d300d6aa24e6","owner_id":"66302798d03b9601c7934ebf","created_at":"2021-09-01T15:34:04.371Z","phone":"+1 (555) 555-0164","phone_status":"no_status","linkedin_url":"https://www.linkedin.com/company/example-corp"}},{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234568","user_id":"66302798d03b9601c7934ebf","created_at":"2025-02-03T15:30:00.000Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd5","person_id":"66e34b81740c50074e3d1bd5","account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with Jane Doe","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","contact":{"id":"66e34b81740c50074e3d1bd5","first_name":"Jane","last_name":"Doe","name":"Jane Doe","linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","title":"Director of Marketing","email":"jane.doe@example.com","organization_name":"Example Corp","photo_url":null,"twitter_url":null,"github_url":null,"facebook_url":null,"account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","present_raw_address":"San Francisco, CA","city":"San Francisco","state":"California","country":"United States","email_status":"verified"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","domain":"example.com","team_id":"6095a710bd01d100a506d4ac","organization_id":"5fc93db64c38d300d6aa24e6","owner_id":"66302798d03b9601c7934ebf","created_at":"2021-09-01T15:34:04.371Z","phone":"+1 (555) 555-0164","phone_status":"no_status","linkedin_url":"https://www.linkedin.com/company/example-corp"}}]}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/tasks/bulk_create is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/bulk_create is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Missing required fields":{"value":"{\n \"error\": \"type and user can not be blank\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/bulk_create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/tasks/{id}":{"get":{"summary":"Get a Task","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Get a Task endpoint to retrieve the full details for a single task that belongs to your team's Apollo account.

The response includes the task's associated account and contact when the task has one attached. Depending on the task type, the response can also include other fields, such as `phone_call` for call tasks, `emailer_message` for email tasks, or a LinkedIn message template for LinkedIn-step tasks.

To find task IDs, use the Search for Tasks endpoint and identify the `id` value for the task you want to view.","tags":["Tasks"],"operationId":"get-a-task","parameters":[{"name":"id","in":"path","description":"The Apollo ID for the task.

To find task IDs, call the Search for Tasks endpoint and identify the `id` value for the task.

Example: `67a1b2c3d4e5f60001234567`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"completed_by_user_id":{},"call_script":{},"relevant_fields":{},"pending_send":{"type":"boolean","example":false},"ai_variables_status":{},"recommended":{"type":"boolean","example":false},"recommendation_reasons":{"type":"array"},"note_text":{"type":"string","example":"","description":"Plain-text version of `note`, with HTML tags stripped. Only present for `call` tasks."},"phone_call":{"type":"object","description":"Details about the logged phone call for this task. Only present for `call` type tasks that have an associated call log.","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d720"},"answered":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"phone_call_outcome_id":{},"phone_call_purpose_id":{},"to_number":{"type":"string","example":"+1 (555) 555-****","description":"The number that was called. May be partially masked depending on your team's phone number redaction settings."}}},"account":{"type":"object","description":"The account associated with this task, when the task has one. Includes the same fields as the View an Account endpoint's response, plus `linkedin_uid` and `account_queues`.","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"name":{"type":"string","example":"Example Corp"},"website_url":{"type":"string","example":"http://www.example.com"},"domain":{"type":"string","example":"example.com"},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/company/example-corp"},"linkedin_uid":{"type":"string","example":"18511550"},"phone":{"type":"string","example":"+1 (555) 555-0164"},"phone_status":{"type":"string","example":"no_status"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"account_stage_id":{},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"industry":{"type":"string","example":"information technology & services"},"estimated_num_employees":{"type":"integer","example":910},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object"},"account_queues":{"type":"array","description":"Play/account-queue memberships for this account."},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"}}},"contact":{"type":"object","description":"The contact associated with this task, when the task has one. Includes the same fields as the View a Contact endpoint's response.","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"name":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"title":{"type":"string","example":"VP of Sales"},"organization_name":{"type":"string","example":"Example Corp"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"contact_stage_id":{},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/in/john-smith-6b2d9f84"},"phone_numbers":{"type":"array"},"contact_emails":{"type":"array","description":"All known email addresses for this contact, with per-address verification status."},"typed_custom_fields":{"type":"object"},"label_ids":{"type":"array"},"created_at":{"type":"string","example":"2024-09-12T18:45:21.456Z"},"updated_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}},"relevant_field_values":{"type":"object","description":"Values for any team-defined relevant fields configured on this task's playbook step, keyed by field name."}}}}},"examples":{"OK":{"value":{"task":{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234567","user_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd4","person_id":null,"account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with John Smith","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","completed_by_user_id":null,"call_script":null,"relevant_fields":null,"pending_send":false,"ai_variables_status":null,"recommended":false,"recommendation_reasons":[],"note_text":"Discuss product demo results and next steps.","phone_call":{"id":"66e8cc45028aed019c25d720","answered":true,"created_at":"2024-09-17T00:24:37.436Z","phone_call_outcome_id":null,"phone_call_purpose_id":null,"to_number":"+1 (555) 555-****"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","website_url":"http://www.example.com","domain":"example.com","linkedin_url":"https://www.linkedin.com/company/example-corp","linkedin_uid":"18511550","phone":"+1 (555) 555-0164","phone_status":"no_status","owner_id":"66302798d03b9601c7934ebf","account_stage_id":null,"organization_id":"5fc93db64c38d300d6aa24e6","industry":"information technology & services","estimated_num_employees":910,"label_ids":[],"typed_custom_fields":{},"account_queues":[],"created_at":"2021-09-01T15:34:04.371Z"},"contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","email":"john.smith@example.com","title":"VP of Sales","organization_name":"Example Corp","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","contact_stage_id":null,"linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","phone_numbers":[],"contact_emails":[{"email":"john.smith@example.com","email_status":"verified"}],"typed_custom_fields":{},"label_ids":[],"created_at":"2024-09-12T18:45:21.456Z","updated_at":"2024-09-17T00:24:37.436Z"},"relevant_field_values":{}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Key lacks required scope":{"value":"{\n \"error\": \"api/v1/tasks/show is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Task functions disabled for this account":{"value":"{\n \"error\": \"You do not have permissions to access task functions.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/show is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Task not found":{"value":"{\n \"error\": \"This task or emailer message has been deleted. Please refresh your page.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/show is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/show is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false},"patch":{"summary":"Update a Task","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Update a Task endpoint to change the details of an existing task that belongs to your team's Apollo account.

The fields you can update depend on the task's current `status`. For a task with a `scheduled` status, you can update any of the parameters listed below. For a task that's already `completed` or `skipped`, you can only update `note`, `priority`, `priority_cd`, and `contact_id`.

To find task IDs, use the Search for Tasks endpoint and identify the `id` value for the task you want to update.","tags":["Tasks"],"operationId":"update-a-task","parameters":[{"name":"id","in":"path","description":"The Apollo ID for the task.

To find task IDs, call the Search for Tasks endpoint and identify the `id` value for the task.

Example: `67a1b2c3d4e5f60001234567`","schema":{"type":"string"},"required":true}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID for the task owner within your team's Apollo account. Only applies to tasks with a `scheduled` status.

Example: `66302798d03b9601c7934ebf`"},"creator_id":{"type":"string","description":"The ID of the user considered the creator of this task. Only applies to tasks with a `scheduled` status.

If this task currently has a `scheduled` status and you omit this parameter, Apollo resets it to the user associated with your API key.

Example: `60affe7d6e270a00f5db6fe4`"},"contact_id":{"type":"string","description":"The Apollo ID for the contact you want on the receiving end of the action.

Example: `66e34b81740c50074e3d1bd4`"},"note":{"type":"string","description":"A description for the task. This should be a human-readable message.

Example: `This contact expressed interest in the Sequences feature specifically. Be prepared to discuss.`"},"type":{"type":"string","description":"Only applies to tasks with a `scheduled` status. Set the task to 1 of the following task types: "},"priority":{"type":"string","description":"Assign a priority to the task: `high`, `medium`, or `low`.

If this task currently has a `scheduled` status and you omit this parameter, Apollo resets its priority to `medium`.","default":"medium"},"priority_cd":{"description":"Numeric-coded alternative to `priority`. Only applies to tasks that are not `scheduled` (already `completed` or `skipped`)."},"status":{"type":"string","description":"Only applies to tasks with a `scheduled` status. To mark a task done, use the Complete a Task or Skip a Task endpoints instead of setting this directly.

Example: `scheduled`"},"due_at":{"type":"string","format":"date-time","description":"Only applies to tasks with a `scheduled` status. The full date and time when the task is due, in ISO 8601 format.

Example: `2025-02-15T08:10:30Z`"},"title":{"type":"string","description":"Only applies to tasks with a `scheduled` status. A title for the task.

Example: `Follow up on demo request`"},"call_script":{"type":"string","description":"Only applies to tasks with a `scheduled` status. A call script or talking points for a `call` type task."},"relevant_fields":{"type":"array","description":"Only applies to tasks with a `scheduled` status. Names of team-defined relevant fields to surface for this task."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"completed_by_user_id":{},"call_script":{},"relevant_fields":{},"pending_send":{"type":"boolean","example":false},"ai_variables_status":{},"recommended":{"type":"boolean","example":false},"recommendation_reasons":{"type":"array"},"note_text":{"type":"string","example":"","description":"Plain-text version of `note`, with HTML tags stripped. Only present for `call` tasks."},"phone_call":{"type":"object","description":"Details about the logged phone call for this task. Only present for `call` type tasks that have an associated call log.","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d720"},"answered":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"phone_call_outcome_id":{},"phone_call_purpose_id":{},"to_number":{"type":"string","example":"+1 (555) 555-****","description":"The number that was called. May be partially masked depending on your team's phone number redaction settings."}}},"account":{"type":"object","description":"The account associated with this task, when the task has one. Includes the same fields as the View an Account endpoint's response, plus `linkedin_uid` and `account_queues`.","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"name":{"type":"string","example":"Example Corp"},"website_url":{"type":"string","example":"http://www.example.com"},"domain":{"type":"string","example":"example.com"},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/company/example-corp"},"linkedin_uid":{"type":"string","example":"18511550"},"phone":{"type":"string","example":"+1 (555) 555-0164"},"phone_status":{"type":"string","example":"no_status"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"account_stage_id":{},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"industry":{"type":"string","example":"information technology & services"},"estimated_num_employees":{"type":"integer","example":910},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object"},"account_queues":{"type":"array","description":"Play/account-queue memberships for this account."},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"}}},"contact":{"type":"object","description":"The contact associated with this task, when the task has one. Includes the same fields as the View a Contact endpoint's response.","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"name":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"title":{"type":"string","example":"VP of Sales"},"organization_name":{"type":"string","example":"Example Corp"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"contact_stage_id":{},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/in/john-smith-6b2d9f84"},"phone_numbers":{"type":"array"},"contact_emails":{"type":"array","description":"All known email addresses for this contact, with per-address verification status."},"typed_custom_fields":{"type":"object"},"label_ids":{"type":"array"},"created_at":{"type":"string","example":"2024-09-12T18:45:21.456Z"},"updated_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}},"relevant_field_values":{"type":"object","description":"Values for any team-defined relevant fields configured on this task's playbook step, keyed by field name."}}}}},"examples":{"OK":{"value":{"task":{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234567","user_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd4","person_id":null,"account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with John Smith","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","completed_by_user_id":null,"call_script":null,"relevant_fields":null,"pending_send":false,"ai_variables_status":null,"recommended":false,"recommendation_reasons":[],"note_text":"Discuss product demo results and next steps.","phone_call":{"id":"66e8cc45028aed019c25d720","answered":true,"created_at":"2024-09-17T00:24:37.436Z","phone_call_outcome_id":null,"phone_call_purpose_id":null,"to_number":"+1 (555) 555-****"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","website_url":"http://www.example.com","domain":"example.com","linkedin_url":"https://www.linkedin.com/company/example-corp","linkedin_uid":"18511550","phone":"+1 (555) 555-0164","phone_status":"no_status","owner_id":"66302798d03b9601c7934ebf","account_stage_id":null,"organization_id":"5fc93db64c38d300d6aa24e6","industry":"information technology & services","estimated_num_employees":910,"label_ids":[],"typed_custom_fields":{},"account_queues":[],"created_at":"2021-09-01T15:34:04.371Z"},"contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","email":"john.smith@example.com","title":"VP of Sales","organization_name":"Example Corp","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","contact_stage_id":null,"linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","phone_numbers":[],"contact_emails":[{"email":"john.smith@example.com","email_status":"verified"}],"typed_custom_fields":{},"label_ids":[],"created_at":"2024-09-12T18:45:21.456Z","updated_at":"2024-09-17T00:24:37.436Z"},"relevant_field_values":{}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}},"application/json":{"examples":{"Task belongs to another user":{"value":"{\n \"error\": \"This task belongs to another user. You do not have permissions to modify other people's tasks.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"This task belongs to another user. You do not have permissions to modify other people's tasks."}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Key lacks required scope":{"value":"{\n \"error\": \"api/v1/tasks/update is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Task functions disabled for this account":{"value":"{\n \"error\": \"You do not have permissions to access task functions.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/update is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Task not found":{"value":"{\n \"error\": \"This task has been deleted. Please refresh your page.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/update is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/update is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/tasks/{id}/complete":{"post":{"summary":"Complete a Task","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Complete a Task endpoint to mark an existing task as `completed`.

To find task IDs, use the Search for Tasks endpoint and identify the `id` value for the task you want to complete.

If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.

To skip a task instead of completing it, use the Skip a Task endpoint.","tags":["Tasks"],"operationId":"complete-a-task","parameters":[{"name":"id","in":"path","description":"The Apollo ID for the task.

To find task IDs, call the Search for Tasks endpoint and identify the `id` value for the task.

Example: `67a1b2c3d4e5f60001234567`","schema":{"type":"string"},"required":true}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"An optional note to record when completing the task.

Example: `Left a voicemail, will follow up next week.`"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"completed_by_user_id":{},"call_script":{},"relevant_fields":{},"pending_send":{"type":"boolean","example":false},"ai_variables_status":{},"recommended":{"type":"boolean","example":false},"recommendation_reasons":{"type":"array"},"phone_call":{"type":"object","description":"Details about the logged phone call for this task. Only present for `call` type tasks that have an associated call log.","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d720"},"answered":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"phone_call_outcome_id":{},"phone_call_purpose_id":{},"to_number":{"type":"string","example":"+1 (555) 555-****","description":"The number that was called. May be partially masked depending on your team's phone number redaction settings."}}},"account":{"type":"object","description":"The account associated with this task, when the task has one. Includes the same fields as the View an Account endpoint's response, plus `linkedin_uid` and `account_queues`.","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"name":{"type":"string","example":"Example Corp"},"website_url":{"type":"string","example":"http://www.example.com"},"domain":{"type":"string","example":"example.com"},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/company/example-corp"},"linkedin_uid":{"type":"string","example":"18511550"},"phone":{"type":"string","example":"+1 (555) 555-0164"},"phone_status":{"type":"string","example":"no_status"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"account_stage_id":{},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"industry":{"type":"string","example":"information technology & services"},"estimated_num_employees":{"type":"integer","example":910},"label_ids":{"type":"array"},"typed_custom_fields":{"type":"object"},"account_queues":{"type":"array","description":"Play/account-queue memberships for this account."},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"}}},"contact":{"type":"object","description":"The contact associated with this task, when the task has one. Includes the same fields as the View a Contact endpoint's response.","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"name":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"title":{"type":"string","example":"VP of Sales"},"organization_name":{"type":"string","example":"Example Corp"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"contact_stage_id":{},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/in/john-smith-6b2d9f84"},"phone_numbers":{"type":"array"},"contact_emails":{"type":"array","description":"All known email addresses for this contact, with per-address verification status."},"typed_custom_fields":{"type":"object"},"label_ids":{"type":"array"},"created_at":{"type":"string","example":"2024-09-12T18:45:21.456Z"},"updated_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}},"relevant_field_values":{"type":"object","description":"Values for any team-defined relevant fields configured on this task's playbook step, keyed by field name."}}},"contact":{"type":"object","description":"The same contact object as `task.contact`, duplicated at the top level of the response.","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"name":{"type":"string","example":"John Smith"},"email":{"type":"string","example":"john.smith@example.com"},"title":{"type":"string","example":"VP of Sales"},"organization_name":{"type":"string","example":"Example Corp"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"contact_stage_id":{},"linkedin_url":{"type":"string","example":"https://www.linkedin.com/in/john-smith-6b2d9f84"},"phone_numbers":{"type":"array"},"contact_emails":{"type":"array","description":"All known email addresses for this contact, with per-address verification status."},"typed_custom_fields":{"type":"object"},"label_ids":{"type":"array"},"created_at":{"type":"string","example":"2024-09-12T18:45:21.456Z"},"updated_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}}}},"examples":{"OK":{"value":{"task":{"emailer_campaign_id":null,"id":"67a1b2c3d4e5f60001234567","user_id":"66302798d03b9601c7934ebf","created_at":"2024-09-12T18:45:21.456Z","completed_at":null,"note":"Discuss product demo results and next steps.","skipped_at":null,"due_at":"2025-02-15T10:00:00.000+00:00","type":"call","priority":"high","status":"scheduled","answered":null,"contact_id":"66e34b81740c50074e3d1bd4","person_id":null,"account_id":"612f9d6cd26c290001d9bda0","organization_id":"5fc93db64c38d300d6aa24e6","persona_ids":[],"subject":null,"created_from":"api","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":"Follow-up call with John Smith","rule_config_id":null,"creator_id":"66302798d03b9601c7934ebf","completed_by_user_id":null,"call_script":null,"relevant_fields":null,"pending_send":false,"ai_variables_status":null,"recommended":false,"recommendation_reasons":[],"phone_call":{"id":"66e8cc45028aed019c25d720","answered":true,"created_at":"2024-09-17T00:24:37.436Z","phone_call_outcome_id":null,"phone_call_purpose_id":null,"to_number":"+1 (555) 555-****"},"account":{"id":"612f9d6cd26c290001d9bda0","name":"Example Corp","website_url":"http://www.example.com","domain":"example.com","linkedin_url":"https://www.linkedin.com/company/example-corp","linkedin_uid":"18511550","phone":"+1 (555) 555-0164","phone_status":"no_status","owner_id":"66302798d03b9601c7934ebf","account_stage_id":null,"organization_id":"5fc93db64c38d300d6aa24e6","industry":"information technology & services","estimated_num_employees":910,"label_ids":[],"typed_custom_fields":{},"account_queues":[],"created_at":"2021-09-01T15:34:04.371Z"},"contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","email":"john.smith@example.com","title":"VP of Sales","organization_name":"Example Corp","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","contact_stage_id":null,"linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","phone_numbers":[],"contact_emails":[{"email":"john.smith@example.com","email_status":"verified"}],"typed_custom_fields":{},"label_ids":[],"created_at":"2024-09-12T18:45:21.456Z","updated_at":"2024-09-17T00:24:37.436Z"},"relevant_field_values":{}},"contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"John","last_name":"Smith","name":"John Smith","email":"john.smith@example.com","title":"VP of Sales","organization_name":"Example Corp","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","contact_stage_id":null,"linkedin_url":"https://www.linkedin.com/in/john-smith-6b2d9f84","phone_numbers":[],"contact_emails":[{"email":"john.smith@example.com","email_status":"verified"}],"typed_custom_fields":{},"label_ids":[],"created_at":"2024-09-12T18:45:21.456Z","updated_at":"2024-09-17T00:24:37.436Z"}}},"Task no longer exists":{"value":{"task":{"id":"67a1b2c3d4e5f60001234567","deleted":true}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Key lacks required scope":{"value":"{\n \"error\": \"api/v1/tasks/complete is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Task functions disabled for this account":{"value":"{\n \"error\": \"You do not have permissions to access task functions.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/complete is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Belongs to another user":{"value":"{\n \"error\": \"This task belongs to another user. Your admin has disabled non-admin users from completing other people's tasks.\"\n}"},"Already completed or skipped":{"value":"{\n \"error\": \"This task is already completed / skipped.\",\n \"allow_moving_to_next_task\": true\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/complete is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/complete is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/tasks/{id}/skip":{"post":{"summary":"Skip a Task","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Skip a Task endpoint to mark an existing task as `skipped` without completing it.

To find task IDs, use the Search for Tasks endpoint and identify the `id` value for the task you want to skip.

If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.

To mark a task as done instead of skipping it, use the Complete a Task endpoint.","tags":["Tasks"],"operationId":"skip-a-task","parameters":[{"name":"id","in":"path","description":"The Apollo ID for the task.

To find task IDs, call the Search for Tasks endpoint and identify the `id` value for the task.

Example: `67a1b2c3d4e5f60001234567`","schema":{"type":"string"},"required":true}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"An optional note to record when skipping the task.

Example: `No longer a good fit, moving to a different sequence.`"},"on_task_page":{"type":"boolean","description":"Whether to reindex the task synchronously so the change is immediately reflected in search results.

Defaults to `false` (indexed asynchronously)."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","example":"67a1b2c3d4e5f60001234567"},"status":{"type":"string","example":"skipped"},"note":{},"completed":{"type":"boolean","example":false}}}}},"examples":{"OK":{"value":{"task":{"id":"67a1b2c3d4e5f60001234567","status":"skipped","note":null,"completed":false}}},"Task no longer exists":{"value":{"task":{"id":"67a1b2c3d4e5f60001234567","deleted":true}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Key lacks required scope":{"value":"{\n \"error\": \"api/v1/tasks/skip is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Task functions disabled for this account":{"value":"{\n \"error\": \"You do not have permissions to access task functions.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/skip is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Belongs to another user":{"value":"{\n \"error\": \"This task belongs to another user. Your admin has disabled non-admins from skipping other people's tasks.\"\n}"},"Already completed or skipped":{"value":"{\n \"error\": \"This task is already completed / skipped.\",\n \"allow_moving_to_next_task\": true\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/skip is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/skip is 200 times per minute. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/tasks/search":{"post":{"summary":"Search for Tasks","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nTasks let you track, prioritize, and help you complete actions required for your outbound sales motion.

Use the Search for Tasks endpoint to find tasks that your team has created in Apollo.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Tasks"],"operationId":"search-tasks","parameters":[{"name":"sort_by_field","in":"query","description":"Sort the tasks by 1 of the following options: ","schema":{"type":"string"}},{"name":"open_factor_names[]","in":"query","description":"Enter `task_types` for this parameter to return a count of tasks by task type.

When used, the response includes a `\"task_types\": []` array with a `\"count\"` value for each task type.","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"tasks":[{"emailer_campaign_id":null,"id":"66e8cc45028aed019c25d724","user_id":"66a3d80d4238fe02d2baaaaf","created_at":"2024-09-17T00:24:37.436Z","completed_at":null,"note":null,"skipped_at":null,"due_at":"2024-09-21T00:00:00.000+00:00","type":"action_item","priority":"medium","status":"scheduled","answered":null,"contact_id":null,"person_id":null,"account_id":null,"organization_id":null,"persona_ids":[],"subject":null,"created_from":null,"salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":"66e8c4567f32a501b2605004","title":"Reminder - Schedule Demo Call","rule_config_id":null,"creator_id":"60affe7d6e270a00f5db6fe4","opportunity":{"id":"66e8c4567f32a501b2605004","team_id":"6095a710bd01d100a506d4ac","owner_id":"66a3d80d4238fe02d2baaaaf","salesforce_owner_id":null,"amount":3000,"closed_date":"2024-11-03T00:00:00.000+00:00","account_id":"612f9d6cd26c290001d9bda0","description":null,"is_closed":false,"is_won":null,"name":"5 Seats of Acme | $2K | Google","stage_name":null,"opportunity_stage_id":"66e4b9b5e5aa6b0e57f078a1","source":"ui_form","salesforce_id":null,"created_at":"2024-09-16T23:50:46.311Z","actual_close_date":null,"next_step":"Schedule Demo","next_step_date":null,"closed_lost_reason":null,"closed_won_reason":null,"forecast_category":"omitted","deal_probability":50,"created_by_id":"60affe7d6e270a00f5db6fe4","current_solutions":null,"deal_source":null,"manually_updated_probability":null,"manually_updated_forecast":null,"crm_id":null,"crm_record_url":null,"crm_owner_id":null,"probability":null,"opportunity_pipeline_id":"66e4b85ce5aa6b03f3f08b6e","stage_updated_at":"2024-09-17T16:44:07.133+00:00","next_step_last_updated_at":"2024-09-17T00:03:13.420+00:00","exchange_rate_code":"USD","exchange_rate_value":1,"amount_in_team_currency":3000,"forecasted_revenue":1500,"last_activity_date":"2024-09-17T16:44:07.134Z","existence_level":"full","typed_custom_fields":{"6095a711bd01d100a506d4da":["6153414ac0559d00016ce5eb"],"6095a711bd01d100a506d4dc":["6153414ac0559d00016ce5f3"],"66e4ba346fe95a073461e00e":["66e4ba346fe95a073461e00c"]},"opportunity_rule_config_statuses":[],"opportunity_contact_roles":[{"id":"66e8c9d7320e8a01b44f1e82","contact_id":"665c3338da53130001243ac4","is_primary":true,"created_at":"2024-09-17T00:14:15.655Z","updated_at":"2024-09-17T00:14:15.655Z","role":[{"opportunity_contact_role_type_id":"64288550ffb0470001cbf2b0","crm_role_id":null,"is_primary":true,"crm_id":null}]}],"currency":{"name":"US Dollar","iso_code":"USD","symbol":"$"},"account":{"id":"612f9d6cd26c290001d9bda0","domain":"google.com","name":"Google","team_id":"6095a710bd01d100a506d4ac","organization_id":"5fc93db64c38d300d6aa24e6","account_stage_id":"6095a710bd01d100a506d4b9","source":"csv_import","original_source":"csv_import","creator_id":null,"owner_id":null,"created_at":"2021-09-01T15:34:04.371Z","phone":null,"phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":null,"account_playbook_statuses":[],"account_rule_config_statuses":[{"_id":"6466e8047759270001e53509","created_at":null,"rule_action_config_id":"64650edd434f8f00a3b13938","rule_config_id":"64650edd434f8f00a3b13939","status_cd":"completed","updated_at":null,"id":"6466e8047759270001e53509","key":"6466e8047759270001e53509"},{"_id":"65735a01fee94b0001245088","created_at":null,"rule_action_config_id":"657358b05ed8f1061a6322e7","rule_config_id":"657358b05ed8f1061a6322e8","status_cd":"completed","updated_at":null,"id":"65735a01fee94b0001245088","key":"65735a01fee94b0001245088"},{"_id":"658118c6b2714c0001e4efe5","created_at":null,"rule_action_config_id":"6580939a36272f01c6eda909","rule_config_id":"6580939a36272f01c6eda90b","status_cd":"completed","updated_at":null,"id":"658118c6b2714c0001e4efe5","key":"658118c6b2714c0001e4efe5"},{"_id":"66141ad2675f2000072834c5","created_at":null,"rule_action_config_id":"65735e0ea63d2700faba5c6e","rule_config_id":"65735e0ea63d2700faba5c6f","status_cd":"completed","updated_at":null,"id":"66141ad2675f2000072834c5","key":"66141ad2675f2000072834c5"}],"existence_level":"full","label_ids":["6466e8261e13be000133f25d"],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Uploaded from CSV","crm_record_url":null,"contact_emailer_campaign_ids":[],"contact_campaign_status_tally":{},"num_contacts":0,"last_activity_date":null}}},{"emailer_campaign_id":"66e9a1d3ad32ac02d20bd289","id":"66e9a57d6bfaef01b3e3e84d","user_id":"66302798d03b9601c7934ebc","created_at":"2024-09-17T15:51:25.594Z","completed_at":null,"note":"","skipped_at":null,"due_at":"2024-09-20T13:05:00.000+00:00","type":"linkedin_step_connect","priority":"medium","status":"scheduled","answered":null,"contact_id":"66e9a56c6bfaef01b3e3e807","person_id":null,"account_id":"664f9e8485c11b000127fd80","organization_id":null,"persona_ids":[],"subject":null,"created_from":"zp_ui","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":null,"rule_config_id":null,"creator_id":null,"account":{"id":"664f9e8485c11b000127fd80","domain":"rewardsnetwork.com","name":"Rewards Network","team_id":"6095a710bd01d100a506d4ac","organization_id":"54a1b496746869401269c209","account_stage_id":"6095a710bd01d100a506d4b7","source":"deployment","original_source":"crm","creator_id":null,"owner_id":null,"created_at":"2024-05-23T19:52:36.137Z","phone":null,"phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":"http://www.linkedin.com/company/rewards-network","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Requested from Apollo","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"account_queues":[]},"contact":{"contact_roles":[],"id":"66e9a56c6bfaef01b3e3e807","first_name":"Trevor","last_name":"Beckett","name":"Trevor Beckett","linkedin_url":"http://www.linkedin.com/in/trevor-beckett-8d3f1a6c","title":"SVP & CFO","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"66302798d03b9601c7934ebc","creator_id":"66302798d03b9601c7934ebc","person_id":"610766bf75b2b20001a70a58","email_needs_tickling":false,"organization_name":"Rewards Network","source":"search","original_source":"search","organization_id":"54a1b496746869401269c209","headline":"CFO, Private Equity","photo_url":null,"present_raw_address":"Greater Chicago Area","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-17T15:51:08.545Z","emailer_campaign_ids":["66e9a1d3ad32ac02d20bd289"],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":"emailer_message_outbound","account_id":"664f9e8485c11b000127fd80","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+18665550159","merged_crm_ids":null,"updated_at":"2024-09-17T15:51:25.590Z","queued_for_crm_push":null,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"trevorbeckett@example.com","email_from_customer":null,"typed_custom_fields":{},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Requested from Apollo","twitter_url":null,"contact_emails":[],"employment_history":[{"_id":"66e73c43a10f5500019f06bc","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"54a1b496746869401269c209","organization_name":"Rewards Network","raw_address":null,"start_date":"2019-09-01","title":"SVP & CFO","updated_at":null,"id":"66e73c43a10f5500019f06bc","key":"66e73c43a10f5500019f06bc"},{"_id":"66e73c43a10f5500019f06bd","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2019-03-01","grade_level":null,"kind":null,"major":null,"organization_id":"5b147886a6da9870e387e5d7","organization_name":"VaaS International Holdings, Inc.","raw_address":null,"start_date":"2017-03-01","title":"SVP & CFO","updated_at":null,"id":"66e73c43a10f5500019f06bd","key":"66e73c43a10f5500019f06bd"},{"_id":"66e73c43a10f5500019f06be","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2016-05-01","grade_level":null,"kind":null,"major":null,"organization_id":"56e60617f3e5bb6b7a000168","organization_name":"Broadwind Energy","raw_address":null,"start_date":"2013-04-01","title":"President, Brad Foote Gearing","updated_at":null,"id":"66e73c43a10f5500019f06be","key":"66e73c43a10f5500019f06be"},{"_id":"66e73c43a10f5500019f06bf","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2013-04-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1d25174686949e780fb13","organization_name":"Pettibone LLC","raw_address":null,"start_date":"2012-06-01","title":"Chief Financial Officer","updated_at":null,"id":"66e73c43a10f5500019f06bf","key":"66e73c43a10f5500019f06bf"},{"_id":"66e73c43a10f5500019f06c0","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2012-06-01","grade_level":null,"kind":null,"major":null,"organization_id":"56e60617f3e5bb6b7a000168","organization_name":"Broadwind Energy","raw_address":null,"start_date":"2011-08-01","title":"Vice President Finance","updated_at":null,"id":"66e73c43a10f5500019f06c0","key":"66e73c43a10f5500019f06c0"},{"_id":"66e73c43a10f5500019f06c1","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2011-06-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a129dc69702d954882c501","organization_name":"Federal Signal Corporation","raw_address":null,"start_date":"2010-03-01","title":"President, Safety and Security Systems Group","updated_at":null,"id":"66e73c43a10f5500019f06c1","key":"66e73c43a10f5500019f06c1"},{"_id":"66e73c43a10f5500019f06c2","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2010-07-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a129dc69702d954882c501","organization_name":"Federal Signal Corporation","raw_address":null,"start_date":"2008-08-01","title":"Vice President & Corporate Controller","updated_at":null,"id":"66e73c43a10f5500019f06c2","key":"66e73c43a10f5500019f06c2"},{"_id":"66e73c43a10f5500019f06c3","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2008-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a129dc69702d954882c501","organization_name":"Federal Signal Corporation","raw_address":null,"start_date":"2006-09-01","title":"Vice President & Treasurer","updated_at":null,"id":"66e73c43a10f5500019f06c3","key":"66e73c43a10f5500019f06c3"},{"_id":"66e73c43a10f5500019f06c4","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2006-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a129dc69702d954882c501","organization_name":"Federal Signal Corporation","raw_address":null,"start_date":"2002-06-01","title":"Vice President, Finance -- Safety Products Group","updated_at":null,"id":"66e73c43a10f5500019f06c4","key":"66e73c43a10f5500019f06c4"},{"_id":"66e73c43a10f5500019f06c5","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2002-06-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Zellweger Analytics, Inc.","raw_address":null,"start_date":"2001-05-01","title":"Vice President, Finance & Administration, Secretary & Treasurer","updated_at":null,"id":"66e73c43a10f5500019f06c5","key":"66e73c43a10f5500019f06c5"},{"_id":"66e73c43a10f5500019f06c6","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2001-01-01","grade_level":null,"kind":null,"major":null,"organization_id":null,"organization_name":"Woodhead Industries, Inc.","raw_address":null,"start_date":"1995-01-01","title":"Controller","updated_at":null,"id":"66e73c43a10f5500019f06c6","key":"66e73c43a10f5500019f06c6"},{"_id":"66e73c43a10f5500019f06c7","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"1987-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"54a1233869702d8ed4ee5703","organization_name":"Deloitte","raw_address":null,"start_date":"1985-01-01","title":"Senior Accountant","updated_at":null,"id":"66e73c43a10f5500019f06c7","key":"66e73c43a10f5500019f06c7"}],"time_zone":"America/Chicago","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 866-555-0159","sanitized_number":"+18665550159","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":null,"dialer_flags":null}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":true,"email_domain_catchall":true},"campaign_name":"1A VIP Executives Chicago Area Sales Team 100 !!","campaign_position":1,"linkedin_emailer_template":{"id":"66e9a4846bfaef02d2e3cd88","body_text":""}},{"emailer_campaign_id":"66e9a1d3ad32ac02d20bd289","id":"66e9a57d6bfaef01b3e3e84e","user_id":"66302798d03b9601c7934ebc","created_at":"2024-09-17T15:51:25.594Z","completed_at":null,"note":"","skipped_at":null,"due_at":"2024-09-20T13:04:00.000+00:00","type":"linkedin_step_connect","priority":"medium","status":"scheduled","answered":null,"contact_id":"66e9a56c6bfaef01b3e3e805","person_id":null,"account_id":"66e9a56c6bfaef01b3e3e809","organization_id":null,"persona_ids":[],"subject":null,"created_from":"zp_ui","salesforce_type":null,"playbook_step_ids":[],"playbook_id":null,"needs_playbook_autoprospecting":null,"starred_by_user_ids":[],"salesforce_id":null,"hubspot_id":null,"opportunity_id":null,"title":null,"rule_config_id":null,"creator_id":null,"account":{"id":"66e9a56c6bfaef01b3e3e809","domain":"radwell.com","name":"Radwell International","team_id":"6095a710bd01d100a506d4ac","organization_id":"5569da7a73696425e291a500","account_stage_id":"6095a710bd01d100a506d4b7","source":"deployment","original_source":"deployment","creator_id":"66302798d03b9601c7934ebc","owner_id":"66302798d03b9601c7934ebc","created_at":"2024-09-17T15:51:08.585Z","phone":"+1 800-555-0185","phone_status":"no_status","hubspot_id":null,"salesforce_id":null,"crm_owner_id":null,"parent_account_id":null,"linkedin_url":"http://www.linkedin.com/company/radwell-international","sanitized_phone":"+18005550185","account_playbook_statuses":[],"account_rule_config_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":null,"modality":"account","source_display_name":"Requested from Apollo","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":false,"intent_signal_account":null,"account_queues":[]},"contact":{"contact_roles":[],"id":"66e9a56c6bfaef01b3e3e805","first_name":"Henry","last_name":"Castellano","name":"Henry Castellano","linkedin_url":"http://www.linkedin.com/in/henry-castellano-4b7e2d95","title":"Chief Financial Officer","contact_stage_id":"6095a710bd01d100a506d4ae","owner_id":"66302798d03b9601c7934ebc","creator_id":"66302798d03b9601c7934ebc","person_id":"5cbfca3c80f93e7bc122b5a4","email_needs_tickling":false,"organization_name":"Radwell International","source":"search","original_source":"search","organization_id":"5569da7a73696425e291a500","headline":"CFO","photo_url":null,"present_raw_address":"Chicago, Illinois, United States","linkedin_uid":"73920514","extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-09-17T15:51:08.545Z","emailer_campaign_ids":["66e9a1d3ad32ac02d20bd289"],"direct_dial_status":null,"direct_dial_enrichment_failed_at":null,"email_status":"verified","email_source":"crm_csv","account_id":"66e9a56c6bfaef01b3e3e809","last_activity_date":null,"hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+18005550185","merged_crm_ids":null,"updated_at":"2024-09-17T15:55:35.475Z","queued_for_crm_push":null,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"label_ids":[],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"hcastellano@example.com","email_from_customer":null,"typed_custom_fields":{},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"contact_rule_config_statuses":[],"source_display_name":"Requested from Apollo","twitter_url":null,"contact_emails":[{"email":"henry.castellano@gmail.com","email_md5":"52f8c287b9696d6d8c96149ae1529f36","email_sha256":"37d698a79304f2a0cb3679e9e391b59c24cae4ca9910ced6e809eb3979ec0270","email_status":"verified","email_source":"rampedup","extrapolated_email_confidence":null,"position":1,"email_from_customer":null,"free_domain":true}],"employment_history":[{"_id":"66d89c837898880001918444","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5569da7a73696425e291a500","organization_name":"Radwell International","raw_address":null,"start_date":"2024-08-01","title":"Chief Financial Officer","updated_at":null,"id":"66d89c837898880001918444","key":"66d89c837898880001918444"},{"_id":"66d89c837898880001918445","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2024-08-01","grade_level":null,"kind":null,"major":null,"organization_id":"55ed663df3e5bb3871001966","organization_name":"Optimas Solutions","raw_address":null,"start_date":"2023-03-01","title":"CFO","updated_at":null,"id":"66d89c837898880001918445","key":"66d89c837898880001918445"},{"_id":"66d89c837898880001918446","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2023-03-01","grade_level":null,"kind":null,"major":null,"organization_id":"5e699a8d1d525e00980b32e4","organization_name":"Caterpillar Inc.","raw_address":null,"start_date":"2022-03-01","title":"Vice President, Corporate FP&A","updated_at":null,"id":"66d89c837898880001918446","key":"66d89c837898880001918446"},{"_id":"66d89c837898880001918447","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2022-03-01","grade_level":null,"kind":null,"major":null,"organization_id":"5e699a8d1d525e00980b32e4","organization_name":"Caterpillar Inc.","raw_address":null,"start_date":"2018-04-01","title":"CFO & VP, Product Support & Logistics Division","updated_at":null,"id":"66d89c837898880001918447","key":"66d89c837898880001918447"},{"_id":"66d89c837898880001918448","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2018-04-01","grade_level":null,"kind":null,"major":null,"organization_id":"5e699a8d1d525e00980b32e4","organization_name":"Caterpillar Inc.","raw_address":null,"start_date":"2017-01-01","title":"Assistant Treasurer, Corporate Treasury","updated_at":null,"id":"66d89c837898880001918448","key":"66d89c837898880001918448"},{"_id":"66d89c837898880001918449","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2012-01-01","grade_level":null,"kind":null,"major":null,"organization_id":"5592234f7369641739ce2f00","organization_name":"Citi","raw_address":null,"start_date":"2009-01-01","title":"Director, Global Metals & Mining","updated_at":null,"id":"66d89c837898880001918449","key":"66d89c837898880001918449"},{"_id":"66d89c83789888000191844a","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2008-12-01","grade_level":null,"kind":null,"major":null,"organization_id":"5592234f7369641739ce2f00","organization_name":"Citi","raw_address":null,"start_date":"2006-01-01","title":"Vice President, Global Metals & Mining","updated_at":null,"id":"66d89c83789888000191844a","key":"66d89c83789888000191844a"},{"_id":"66d89c83789888000191844b","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2005-12-01","grade_level":null,"kind":null,"major":null,"organization_id":"5592234f7369641739ce2f00","organization_name":"Citi","raw_address":null,"start_date":"2002-08-01","title":"Associate, Generalist","updated_at":null,"id":"66d89c83789888000191844b","key":"66d89c83789888000191844b"},{"_id":"66d89c83789888000191844c","created_at":null,"current":false,"degree":null,"description":null,"emails":null,"end_date":"2002-06-01","grade_level":null,"kind":null,"major":null,"organization_id":"5592234f7369641739ce2f00","organization_name":"Citi","raw_address":null,"start_date":"1999-07-01","title":"Analyst, Global Consumer Group","updated_at":null,"id":"66d89c83789888000191844c","key":"66d89c83789888000191844c"}],"time_zone":"America/Chicago","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 800-555-0185","sanitized_number":"+18005550185","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":null,"dialer_flags":null}],"account_phone_note":null,"free_domain":false,"is_likely_to_engage":true,"email_domain_catchall":true},"campaign_name":"1A VIP Executives Chicago Area Sales Team 100 !!","campaign_position":1,"linkedin_emailer_template":{"id":"66e9a4846bfaef02d2e3cd88","body_text":""}}],"breadcrumbs":[],"pagination":{"page":1,"per_page":3,"total_entries":179,"total_pages":60},"faceting":{"playbook_step_facets":[],"person_function_facets":[],"person_seniority_facets":[],"normalized_person_title_facets":[],"organization_ids_facets":[],"organization_ids_in_query_facets":[],"person_persona_facets":[],"organization_keywords_facets":[],"linkedin_industry_facets":[],"num_employees_facets":[],"revenues_facets":[],"currently_using_any_of_technology_uids_facets":[],"currently_using_all_of_technology_uids_facets":[],"currently_not_using_any_of_technology_uids_facets":[],"added_technology_uids_facets":[],"dropped_technology_uids_facets":[],"latest_funding_stage_facets":[],"organization_trading_status_facets":[],"person_city_facets":[],"person_state_facets":[],"person_country_facets":[],"organization_hq_city_facets":[],"organization_hq_state_facets":[],"organization_hq_country_facets":[],"organization_intent_scoring_facets":[],"forecast_category_facets":[],"intent_topic_count_facets":[],"task_types":[{"value":"contact_call","display_name":"Call Contact","count":30},{"value":"outreach_manual_email","display_name":"Email Contact","count":23},{"value":"contact_action_item","display_name":"Contact Action Item","count":53},{"value":"account_action_item","display_name":"Account Action Item","count":16},{"value":"account_add_people_action","display_name":"Add People on Account","count":31},{"value":"linkedin_actions","display_name":"Linkedin Actions","count":26},{"value":"linkedin_step_connect","display_name":"LI: Send connection request","count":26}],"total_facets":[{"value":"pipeline_total","display_name":"Total","count":179}],"linkedin_task":[],"contact_stage_facets":[]},"pipeline_total":179,"num_fetch_result":null}}},"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"emailer_campaign_id":{},"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"},"completed_at":{},"note":{},"skipped_at":{},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"status":{"type":"string","example":"scheduled"},"answered":{},"contact_id":{},"person_id":{},"account_id":{},"organization_id":{},"persona_ids":{"type":"array"},"subject":{},"created_from":{},"salesforce_type":{},"playbook_step_ids":{"type":"array"},"playbook_id":{},"needs_playbook_autoprospecting":{},"starred_by_user_ids":{"type":"array"},"salesforce_id":{},"hubspot_id":{},"opportunity_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"rule_config_id":{},"creator_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"opportunity":{"type":"object","properties":{"id":{"type":"string","example":"66e8c4567f32a501b2605004"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"owner_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"salesforce_owner_id":{},"amount":{"type":"integer","example":3000,"default":0},"closed_date":{"type":"string","example":"2024-11-03T00:00:00.000+00:00"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"description":{},"is_closed":{"type":"boolean","example":false,"default":true},"is_won":{},"name":{"type":"string","example":"5 Seats of Acme | $2K | Google"},"stage_name":{},"opportunity_stage_id":{"type":"string","example":"66e4b9b5e5aa6b0e57f078a1"},"source":{"type":"string","example":"ui_form"},"salesforce_id":{},"created_at":{"type":"string","example":"2024-09-16T23:50:46.311Z"},"actual_close_date":{},"next_step":{"type":"string","example":"Schedule Demo"},"next_step_date":{},"closed_lost_reason":{},"closed_won_reason":{},"forecast_category":{"type":"string","example":"omitted"},"deal_probability":{"type":"integer","example":50,"default":0},"created_by_id":{"type":"string","example":"60affe7d6e270a00f5db6fe4"},"current_solutions":{},"deal_source":{},"manually_updated_probability":{},"manually_updated_forecast":{},"crm_id":{},"crm_record_url":{},"crm_owner_id":{},"probability":{},"opportunity_pipeline_id":{"type":"string","example":"66e4b85ce5aa6b03f3f08b6e"},"stage_updated_at":{"type":"string","example":"2024-09-17T16:44:07.133+00:00"},"next_step_last_updated_at":{"type":"string","example":"2024-09-17T00:03:13.420+00:00"},"exchange_rate_code":{"type":"string","example":"USD"},"exchange_rate_value":{"type":"integer","example":1,"default":0},"amount_in_team_currency":{"type":"integer","example":3000,"default":0},"forecasted_revenue":{"type":"integer","example":1500,"default":0},"last_activity_date":{"type":"string","example":"2024-09-17T16:44:07.134Z"},"existence_level":{"type":"string","example":"full"},"typed_custom_fields":{"type":"object","properties":{"6095a711bd01d100a506d4da":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5eb"}},"6095a711bd01d100a506d4dc":{"type":"array","items":{"type":"string","example":"6153414ac0559d00016ce5f3"}},"66e4ba346fe95a073461e00e":{"type":"array","items":{"type":"string","example":"66e4ba346fe95a073461e00c"}}}},"opportunity_rule_config_statuses":{"type":"array"},"opportunity_contact_roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"66e8c9d7320e8a01b44f1e82"},"contact_id":{"type":"string","example":"665c3338da53130001243ac4"},"is_primary":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"updated_at":{"type":"string","example":"2024-09-17T00:14:15.655Z"},"role":{"type":"array","items":{"type":"object","properties":{"opportunity_contact_role_type_id":{"type":"string","example":"64288550ffb0470001cbf2b0"},"crm_role_id":{},"is_primary":{"type":"boolean","example":true,"default":true},"crm_id":{}}}}}}},"currency":{"type":"object","properties":{"name":{"type":"string","example":"US Dollar"},"iso_code":{"type":"string","example":"USD"},"symbol":{"type":"string","example":"$"}}},"account":{"type":"object","properties":{"id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"domain":{"type":"string","example":"google.com"},"name":{"type":"string","example":"Google"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"organization_id":{"type":"string","example":"5fc93db64c38d300d6aa24e6"},"account_stage_id":{"type":"string","example":"6095a710bd01d100a506d4b9"},"source":{"type":"string","example":"csv_import"},"original_source":{"type":"string","example":"csv_import"},"creator_id":{},"owner_id":{},"created_at":{"type":"string","example":"2021-09-01T15:34:04.371Z"},"phone":{},"phone_status":{"type":"string","example":"no_status"},"hubspot_id":{},"salesforce_id":{},"crm_owner_id":{},"parent_account_id":{},"linkedin_url":{},"account_playbook_statuses":{"type":"array"},"account_rule_config_statuses":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"6466e8047759270001e53509"},"created_at":{},"rule_action_config_id":{"type":"string","example":"64650edd434f8f00a3b13938"},"rule_config_id":{"type":"string","example":"64650edd434f8f00a3b13939"},"status_cd":{"type":"string","example":"completed"},"updated_at":{},"id":{"type":"string","example":"6466e8047759270001e53509"},"key":{"type":"string","example":"6466e8047759270001e53509"}}}},"existence_level":{"type":"string","example":"full"},"label_ids":{"type":"array","items":{"type":"string","example":"6466e8261e13be000133f25d"}},"typed_custom_fields":{"type":"object","properties":{}},"custom_field_errors":{},"modality":{"type":"string","example":"account"},"source_display_name":{"type":"string","example":"Uploaded from CSV"},"crm_record_url":{},"contact_emailer_campaign_ids":{"type":"array"},"contact_campaign_status_tally":{"type":"object","properties":{}},"num_contacts":{"type":"integer","example":0,"default":0},"last_activity_date":{}}}}}}}},"breadcrumbs":{"type":"array"},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"per_page":{"type":"integer","example":3,"default":0},"total_entries":{"type":"integer","example":179,"default":0},"total_pages":{"type":"integer","example":60,"default":0}}},"faceting":{"type":"object","properties":{"playbook_step_facets":{"type":"array"},"person_function_facets":{"type":"array"},"person_seniority_facets":{"type":"array"},"normalized_person_title_facets":{"type":"array"},"organization_ids_facets":{"type":"array"},"organization_ids_in_query_facets":{"type":"array"},"person_persona_facets":{"type":"array"},"organization_keywords_facets":{"type":"array"},"linkedin_industry_facets":{"type":"array"},"num_employees_facets":{"type":"array"},"revenues_facets":{"type":"array"},"currently_using_any_of_technology_uids_facets":{"type":"array"},"currently_using_all_of_technology_uids_facets":{"type":"array"},"currently_not_using_any_of_technology_uids_facets":{"type":"array"},"added_technology_uids_facets":{"type":"array"},"dropped_technology_uids_facets":{"type":"array"},"latest_funding_stage_facets":{"type":"array"},"organization_trading_status_facets":{"type":"array"},"person_city_facets":{"type":"array"},"person_state_facets":{"type":"array"},"person_country_facets":{"type":"array"},"organization_hq_city_facets":{"type":"array"},"organization_hq_state_facets":{"type":"array"},"organization_hq_country_facets":{"type":"array"},"organization_intent_scoring_facets":{"type":"array"},"forecast_category_facets":{"type":"array"},"intent_topic_count_facets":{"type":"array"},"task_types":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"contact_call"},"display_name":{"type":"string","example":"Call Contact"},"count":{"type":"integer","example":30,"default":0}}}},"total_facets":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"pipeline_total"},"display_name":{"type":"string","example":"Total"},"count":{"type":"integer","example":179,"default":0}}}},"linkedin_task":{"type":"array"},"contact_stage_facets":{"type":"array"}}},"pipeline_total":{"type":"integer","example":179,"default":0},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/tasks/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"oneOf":[{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/tasks/search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}},{"title":"Check Apollo pricing plan","type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}]}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Address the required parameters":{"value":"{\n \"error\": \"Something's wrong with your API request. undefined method `[]' for nil\"\n}"},"Too many search results per page":{"value":"{\n \"error\": \"Per page not supported\"\n}"}},"schema":{"oneOf":[{"title":"Address the required parameters","type":"object","properties":{"error":{"type":"string","example":"Something's wrong with your API request. undefined method `[]' for nil"}}},{"title":"Too many search results per page","type":"object","properties":{"error":{"type":"string","example":"Per page not supported"}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/tasks/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/tasks/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/emailer_messages":{"post":{"summary":"Create an Email Draft","description":"Use the Create an Email Draft endpoint to create a single, unsent email message (an email draft) for a contact. The draft is created with a `drafted` status β€” this endpoint does not send the email.

To send the draft after creating it, call the Send Email Now endpoint with the `id` returned in the response.

You must provide a `contact_id` so Apollo knows who the email is for. Alternatively, to draft a reply within an existing email thread, provide `in_response_to_emailer_message_id` instead and Apollo will infer the contact and recipients from the parent message.

The email is drafted from the user that owns the API key. That user must have permission to email the contact (i.e. they own the contact or its account), and the contact must not be blocked by your team's Do Not Contact (DNC) enforcement settings.

This endpoint returns the created `emailer_message` object. If the draft is linked to an outreach task, a `task` object is also returned.","tags":["Emailer Messages"],"operationId":"create-an-email-draft","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contact_id"],"properties":{"contact_id":{"type":"string","description":"The Apollo ID for the contact that will receive the email.

This is required unless you provide `in_response_to_emailer_message_id`, in which case the contact is inferred from the parent message.

To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.

Example: `66e34b81740c50074e3d1bd4`"},"subject":{"type":"string","description":"The subject line of the email.

Example: `Quick question about your team's workflow`"},"body_html":{"type":"string","description":"The body of the email as HTML. The content is sanitized by Apollo before it is saved.

Example: `

Hi there, I wanted to reach out about...

`"},"recipients":{"type":"array","description":"The list of recipients for the email. Use this to set the `to`, `cc`, and `bcc` recipients. If you do not provide a `to` recipient, Apollo keeps the existing `to` recipients (if any).

All recipient emails must be valid, otherwise the request fails and the email is not saved.","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the recipient.

Example: `ava.ruiz@sumware.com`"},"contact_id":{"type":"string","description":"The Apollo ID for the contact associated with this recipient.

Example: `66e34b81740c50074e3d1bd4`"},"recipient_type_cd":{"type":"string","description":"The type of recipient. "}}}},"in_response_to_emailer_message_id":{"type":"string","description":"The Apollo ID of an existing email message that this draft is replying to. When provided, Apollo infers the contact and builds the recipients from the parent message, so you do not need to provide `contact_id`.

Example: `66e8cc45028aed019c25d724`"},"emailer_template_id":{"type":"string","description":"The Apollo ID of an email template to associate with the draft.

Example: `66e8cc45028aed019c25d725`"},"attachment_ids":{"type":"array","items":{"type":"string"},"description":"The Apollo IDs of the attachments to include with the email."},"enable_tracking":{"type":"boolean","description":"Set to `true` to enable open and click tracking for the email. This is only applied if your team is permitted to track emails.

Example: `true`"},"outreach_task_id":{"type":"string","description":"The Apollo ID of an outreach task to associate with the draft. If a drafted email already exists for this task, Apollo links to that draft instead of creating a new one.

Example: `66e8cc45028aed019c25d726`"}}},"examples":{"Create an email draft for a contact":{"value":{"contact_id":"66e34b81740c50074e3d1bd4","subject":"Quick question about your team's workflow","body_html":"

Hi Ava, I wanted to reach out about how Apollo can help your team.

","recipients":[{"email":"ava.ruiz@sumware.com","contact_id":"66e34b81740c50074e3d1bd4","recipient_type_cd":"to"}],"enable_tracking":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"emailer_message":{"type":"object","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"status":{"type":"string","example":"drafted"},"time_zone":{},"provider_message_id":{},"to_name":{"type":"string","example":"Ava Ruiz"},"due_at":{},"completed_at":{},"emailer_touch_id":{},"emailer_campaign_id":{},"emailer_step_id":{},"failed_at":{},"failure_reason":{},"attachment_ids":{"type":"array"},"enable_tracking":{"type":"boolean","example":true},"type":{"type":"string","example":"outreach_manual_email"},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"provider_thread_id":{},"schedule_delayed_reason":{},"demoed":{},"email_account_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"due_at_manually_changed":{},"not_sent_reason":{},"bounce":{},"spam_blocked":{},"tracking_disabled_reason":{},"created_at":{"type":"string","example":"2025-02-03T15:30:00.000Z"},"async_sending":{},"due_at_source":{},"crm_id":{},"replied":{},"needs_dynamic_assemble":{},"personalized_opener":{},"reply_class":{},"schedule_delayed_limit_reason":{},"schedule_delayed_reason_details":{},"sensitive_info_redacted":{},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"conversation_id":{},"click_tracking_enabled":{"type":"boolean","example":true},"open_tracking_enabled":{"type":"boolean","example":true},"ai_variables_status":{},"recipients":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"ava.ruiz@sumware.com"},"raw_name":{"type":"string","example":"Ava Ruiz"},"recipient_type_cd":{"type":"string","example":"to"},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"user_id":{}}}},"send_from":{"type":"object","properties":{"email":{"type":"string","example":"someemail@apollo.io"},"raw_name":{},"recipient_type_cd":{},"contact_id":{},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"}}},"from_email":{"type":"string","example":"someemail@apollo.io"},"to_email":{"type":"string","example":"ava.ruiz@sumware.com"},"from_name":{},"bcc_emails":{"type":"array"},"cc_emails":{"type":"array"},"send_from_info":{"type":"string","example":"66e8c4567f32a501b2605004***someemail@apollo.io"},"body_text":{"type":"string","example":"Hi Ava, I wanted to reach out about how Apollo can help your team."},"body_html":{"type":"string","example":"

Hi Ava, I wanted to reach out about how Apollo can help your team.

"},"body_html_loaded":{"type":"boolean","example":true},"subject":{"type":"string","example":"Quick question about your team's workflow"},"contact":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"Ava"},"last_name":{"type":"string","example":"Ruiz"},"name":{"type":"string","example":"Ava Ruiz"},"email":{"type":"string","example":"ava.ruiz@sumware.com"},"title":{"type":"string","example":"Founder & CEO"},"organization_name":{"type":"string","example":"Sumware Software"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"email_status":{"type":"string","example":"verified"}}}}}},"task":{"type":"object","description":"The outreach task linked to this email message. Only returned when the message is associated with an outreach task (for example, when `outreach_task_id` is provided).

A condensed set of fields is shown below. For the full task object and all available fields, see the Search for Tasks endpoint.","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"status":{"type":"string","example":"scheduled"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"completed_at":{},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"subject":{},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"account_id":{},"opportunity_id":{},"emailer_campaign_id":{},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}}},"examples":{"Result":{"value":{"emailer_message":{"id":"66e8cc45028aed019c25d724","user_id":"66a3d80d4238fe02d2baaaaf","status":"drafted","to_name":"Ava Ruiz","due_at":null,"completed_at":null,"emailer_campaign_id":null,"attachment_ids":[],"enable_tracking":true,"type":"outreach_manual_email","contact_id":"66e34b81740c50074e3d1bd4","email_account_id":"66e8c4567f32a501b2605004","created_at":"2025-02-03T15:30:00.000Z","account_id":"612f9d6cd26c290001d9bda0","click_tracking_enabled":true,"open_tracking_enabled":true,"recipients":[{"email":"ava.ruiz@sumware.com","raw_name":"Ava Ruiz","recipient_type_cd":"to","contact_id":"66e34b81740c50074e3d1bd4"}],"send_from":{"email":"someemail@apollo.io","user_id":"66a3d80d4238fe02d2baaaaf"},"from_email":"someemail@apollo.io","to_email":"ava.ruiz@sumware.com","bcc_emails":[],"cc_emails":[],"send_from_info":"66e8c4567f32a501b2605004***someemail@apollo.io","body_text":"Hi Ava, I wanted to reach out about how Apollo can help your team.","body_html":"

Hi Ava, I wanted to reach out about how Apollo can help your team.

","body_html_loaded":true,"subject":"Quick question about your team's workflow","contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"Ava","last_name":"Ruiz","name":"Ava Ruiz","email":"ava.ruiz@sumware.com","title":"Founder & CEO","organization_name":"Sumware Software","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","email_status":"verified"}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Contact does not exist":{"value":"{\n \"error\": \"Contact does not exist\"\n}"},"No permission to email contact":{"value":"{\n \"error\": \"You do not have permission to email Ava Ruiz. You are not the owner of this contact or account.\"\n}"},"Blocked by DNC enforcement":{"value":"{\n \"error\": \"Cannot be emailed under your team's DNC enforcement settings\",\n \"error_code\": \"DNC_ENFORCEMENT_BLOCKED\"\n}"},"Invalid recipient emails":{"value":"{\n \"error\": \"ERROR! Email is NOT SAVED. Invalid recipient emails: [\\\"person@\\\"]\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"},"error_code":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_messages/create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_messages/create is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/emailer_messages/{id}/send_now":{"post":{"summary":"Send Email Now","description":"Use the Send Email Now endpoint to immediately send an existing email message. This works for emails that are currently in a `drafted`, `scheduled`, or `failed` state β€” Apollo schedules the email to be sent right away and processes it asynchronously.

To first create an email draft, use the Create an Email Draft endpoint and then pass the returned `id` to this endpoint.

The email is sent from the user that owns the API key. That user must have a linked email account on the message, must have permission to send from that email account, and must have permission to email the contact. The contact must also not be blocked by your team's Do Not Contact (DNC) enforcement settings, and the user must not have exceeded their daily sending limit.

Because sending is processed asynchronously, a successful `200` response means the email has been queued for sending β€” not that it has been delivered. To check whether the email was delivered, poll the Check Email Send Status endpoint using the message `id`.

This endpoint returns the `emailer_message` object. If the message is linked to an outreach task, a `task` object is also returned.","tags":["Emailer Messages"],"operationId":"send-email-now","parameters":[{"name":"id","in":"path","required":true,"description":"The Apollo ID of the email message to send. This is the `id` returned when you create an email draft.

Example: `66e8cc45028aed019c25d724`","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"surface":{"type":"string","description":"Optional. The surface within Apollo that the send is initiated from. Used for internal attribution and analytics.

Example: `emails`"}}},"examples":{"Send an existing email immediately":{"value":{"surface":"emails"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"emailer_message":{"type":"object","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"status":{"type":"string","example":"scheduled"},"to_name":{"type":"string","example":"Ava Ruiz"},"due_at":{"type":"string","example":"2025-02-03T15:30:00.000+00:00"},"completed_at":{},"emailer_campaign_id":{},"attachment_ids":{"type":"array"},"enable_tracking":{"type":"boolean","example":true},"type":{"type":"string","example":"outreach_manual_email"},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"email_account_id":{"type":"string","example":"66e8c4567f32a501b2605004"},"due_at_manually_changed":{"type":"boolean","example":true},"due_at_source":{"type":"string","example":"Email was sent using Send Now action"},"async_sending":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-02-03T15:30:00.000Z"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"click_tracking_enabled":{"type":"boolean","example":true},"open_tracking_enabled":{"type":"boolean","example":true},"recipients":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"ava.ruiz@sumware.com"},"raw_name":{"type":"string","example":"Ava Ruiz"},"recipient_type_cd":{"type":"string","example":"to"},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"user_id":{}}}},"send_from":{"type":"object","properties":{"email":{"type":"string","example":"someemail@apollo.io"},"raw_name":{},"recipient_type_cd":{},"contact_id":{},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"}}},"from_email":{"type":"string","example":"someemail@apollo.io"},"to_email":{"type":"string","example":"ava.ruiz@sumware.com"},"from_name":{},"bcc_emails":{"type":"array"},"cc_emails":{"type":"array"},"send_from_info":{"type":"string","example":"66e8c4567f32a501b2605004***someemail@apollo.io"},"body_text":{"type":"string","example":"Hi Ava, I wanted to reach out about how Apollo can help your team."},"body_html":{"type":"string","example":"

Hi Ava, I wanted to reach out about how Apollo can help your team.

"},"body_html_loaded":{"type":"boolean","example":true},"subject":{"type":"string","example":"Quick question about your team's workflow"},"contact":{"type":"object","properties":{"id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"first_name":{"type":"string","example":"Ava"},"last_name":{"type":"string","example":"Ruiz"},"name":{"type":"string","example":"Ava Ruiz"},"email":{"type":"string","example":"ava.ruiz@sumware.com"},"title":{"type":"string","example":"Founder & CEO"},"organization_name":{"type":"string","example":"Sumware Software"},"account_id":{"type":"string","example":"612f9d6cd26c290001d9bda0"},"owner_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"email_status":{"type":"string","example":"verified"}}}}}},"task":{"type":"object","description":"The outreach task linked to this email message. Only returned when the message is associated with an outreach task (for example, when `outreach_task_id` is provided).

A condensed set of fields is shown below. For the full task object and all available fields, see the Search for Tasks endpoint.","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"user_id":{"type":"string","example":"66a3d80d4238fe02d2baaaaf"},"status":{"type":"string","example":"scheduled"},"type":{"type":"string","example":"action_item"},"priority":{"type":"string","example":"medium"},"due_at":{"type":"string","example":"2024-09-21T00:00:00.000+00:00"},"completed_at":{},"title":{"type":"string","example":"Reminder - Schedule Demo Call"},"subject":{},"contact_id":{"type":"string","example":"66e34b81740c50074e3d1bd4"},"account_id":{},"opportunity_id":{},"emailer_campaign_id":{},"created_at":{"type":"string","example":"2024-09-17T00:24:37.436Z"}}}},"examples":{"Result":{"value":{"emailer_message":{"id":"66e8cc45028aed019c25d724","user_id":"66a3d80d4238fe02d2baaaaf","status":"scheduled","to_name":"Ava Ruiz","due_at":"2025-02-03T15:30:00.000+00:00","completed_at":null,"emailer_campaign_id":null,"attachment_ids":[],"enable_tracking":true,"type":"outreach_manual_email","contact_id":"66e34b81740c50074e3d1bd4","email_account_id":"66e8c4567f32a501b2605004","due_at_manually_changed":true,"due_at_source":"Email was sent using Send Now action","async_sending":true,"created_at":"2025-02-03T15:30:00.000Z","account_id":"612f9d6cd26c290001d9bda0","click_tracking_enabled":true,"open_tracking_enabled":true,"recipients":[{"email":"ava.ruiz@sumware.com","raw_name":"Ava Ruiz","recipient_type_cd":"to","contact_id":"66e34b81740c50074e3d1bd4"}],"send_from":{"email":"someemail@apollo.io","user_id":"66a3d80d4238fe02d2baaaaf"},"from_email":"someemail@apollo.io","to_email":"ava.ruiz@sumware.com","bcc_emails":[],"cc_emails":[],"send_from_info":"66e8c4567f32a501b2605004***someemail@apollo.io","body_text":"Hi Ava, I wanted to reach out about how Apollo can help your team.","body_html":"

Hi Ava, I wanted to reach out about how Apollo can help your team.

","body_html_loaded":true,"subject":"Quick question about your team's workflow","contact":{"id":"66e34b81740c50074e3d1bd4","first_name":"Ava","last_name":"Ruiz","name":"Ava Ruiz","email":"ava.ruiz@sumware.com","title":"Founder & CEO","organization_name":"Sumware Software","account_id":"612f9d6cd26c290001d9bda0","owner_id":"66302798d03b9601c7934ebf","email_status":"verified"}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Email not found or deleted":{"value":"{\n \"error\": \"This email has already been deleted. Please refresh the page.\"\n}"},"Message belongs to another team":{"value":"{\n \"error\": \"Could not find message to send.\"\n}"},"No email account linked":{"value":"{\n \"error\": \"Please specify where to send the email from!\"\n}"},"No permission to send from email account":{"value":"{\n \"error\": \"You do not have permission to send from this email account\"\n}"},"Daily sending limit reached":{"value":"{\n \"error\": \"You have reached your daily email sending limit. Contact your admin to adjust your sending limits.\",\n \"error_code\": \"SEND_NOW_LIMIT_EXCEEDED\"\n}"},"Daily sending limit reached (seller limit)":{"value":"{\n \"error\": \"Failed to send as maximum # of emails for Call Assistant to send per day for the sequence is low\",\n \"error_code\": \"SELLER_EMAIL_LIMIT_EXCEEDED\"\n}"},"No permission to email contact":{"value":"{\n \"error\": \"You do not have permission to email Ava Ruiz. You are not the owner of this contact or account.\"\n}"},"Blocked by DNC enforcement":{"value":"{\n \"error\": \"Cannot be emailed under your team's DNC enforcement settings\",\n \"error_code\": \"DNC_ENFORCEMENT_BLOCKED\"\n}"},"Email task belongs to another user":{"value":"{\n \"error\": \"You can not send this email. Email task is assigned to another user.\"\n}"},"Email already sent":{"value":"{\n \"error\": \"This email has already been sent!\"\n}"},"Email currently being sent":{"value":"{\n \"error\": \"This email is currently being sent already! Wait up to 20 seconds and refresh this page.\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string"},"error_code":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_messages/send_now is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_messages/send_now is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/emailer_messages/email_send_status":{"post":{"summary":"Check Email Send Status","description":"Use the Check Email Send Status endpoint to check the current delivery status of an email message. This is typically used after calling the Send Email Now endpoint, since emails are sent asynchronously and a successful send response only means the email was queued.

You must provide the `id` of the email message. The message must belong to your team, otherwise a `404` is returned.

The response always includes the message `id`, its current `status`, and a human-readable `message`. The remaining fields depend on the status: ","tags":["Emailer Messages"],"operationId":"check-email-send-status","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Apollo ID of the email message to check. This is the `id` returned when you create an email draft or send an email.

Example: `66e8cc45028aed019c25d724`"}}},"examples":{"Check the status of an email":{"value":{"id":"66e8cc45028aed019c25d724"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"66e8cc45028aed019c25d724"},"status":{"type":"string","example":"completed"},"message":{"type":"string","example":"Email delivered successfully."},"completed_at":{"type":"string","format":"date-time","example":"2025-02-03T15:30:00Z"},"not_sent_reason":{"type":"string","example":"no_active_email_account"},"failure_reason":{"type":"string","example":"Mailbox disconnected"},"failed_at":{"type":"string","format":"date-time","example":"2025-02-03T15:30:00Z"},"retry_after_seconds":{"type":"integer","example":10}}},"examples":{"Email delivered":{"value":{"id":"66e8cc45028aed019c25d724","status":"completed","message":"Email delivered successfully.","completed_at":"2025-02-03T15:30:00Z"}},"Email failed":{"value":{"id":"66e8cc45028aed019c25d724","status":"failed","message":"Email failed to send.","not_sent_reason":"no_active_email_account","failure_reason":"Mailbox disconnected","failed_at":"2025-02-03T15:30:00Z"}},"Email still being processed":{"value":{"id":"66e8cc45028aed019c25d724","status":"scheduled","message":"Email is still being processed. Try again in 10-20 seconds.","retry_after_seconds":10}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Email message not found":{"value":"{\n \"error\": \"Email message not found\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Email message not found"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Missing required parameter":{"value":"{\n \"error\": \"Missing required parameter: id\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"Missing required parameter: id"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_messages/email_send_status is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_messages/email_send_status is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/users/search":{"get":{"summary":"Get a List of Users","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUsers are the people who use your Apollo workspace.

Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.

These IDs can be used for several other endpoints, including the Create a Deal, Create an Account, and Create a Task endpoints.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master API key.","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.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

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"},"territory_location_override":{"type":"boolean","example":false,"default":true},"territory_locations":{"type":"array","items":{"type":"string","example":"United States"}},"territory_person_locations":{"type":"array","items":{"type":"string","example":"United States"}},"user_id":{"type":"string","example":"66c8db577ed7f201b25c0eef"},"id":{"type":"string","example":"66c8db587ed7f201b25c0ef0"},"key":{"type":"string","example":"66c8db587ed7f201b25c0ef0"}}},"fields_fully_loaded":{"type":"boolean","example":true,"default":true},"typed_custom_fields":{},"connected_to_slack":{"type":"boolean","example":false,"default":true},"crm_email":{},"triggered_referral_campaigns":{"type":"array"},"enable_click_tracking":{"type":"boolean","example":false,"default":true},"enable_open_tracking":{"type":"boolean","example":true,"default":true},"should_include_unsubscribe_link":{"type":"boolean","example":false,"default":true},"enable_one_click_unsubscribe":{},"subteam_ids":{"type":"array"},"prospect_territory_ids":{"type":"array"},"toggled_on_territory_ids":{"type":"array"},"linked_salesforce":{},"linked_zoom_conference_account":{"type":"boolean","example":false,"default":true},"linked_bot_conference_account":{"type":"boolean","example":true,"default":true},"linked_bot_conference_account_platforms":{"type":"array","items":{"type":"string","example":"google_meet"}},"has_conference_account":{"type":"boolean","example":true,"default":true},"linked_hubspot":{"type":"boolean","example":false,"default":true},"linked_salesloft":{"type":"boolean","example":false,"default":true},"linked_crm_name":{},"chrome_extension_enabled_features":{"type":"array","items":{"type":"string","example":"apollo_everywhere"}},"chrome_extension_exclude_from_websites":{"type":"array","items":{"type":"string","example":"facebook.com"}},"chrome_extension_everywhere_icon_horizontal_position":{"type":"string","example":"right"},"chrome_extension_everywhere_icon_vertical_position_in_vh":{"type":"integer","example":10,"default":0},"default_chrome_extension_log_email_send_to_salesforce":{"type":"boolean","example":true,"default":true},"default_chrome_extension_log_email_send_to_hubspot":{"type":"boolean","example":true,"default":true},"chrome_extension_auto_match_salesforce_opportunity":{"type":"boolean","example":true,"default":true},"chrome_extension_gmail_enable_email_tools":{"type":"boolean","example":true,"default":true},"enable_desktop_notifications":{"type":"boolean","example":false,"default":true},"enable_gmail_desktop_notifications":{},"default_chrome_extension_enable_reminders":{"type":"boolean","example":false,"default":true},"chrome_extension_gmail_enable_crm_sidebar":{"type":"boolean","example":true,"default":true},"show_chrome_extension_buying_intent_promo":{"type":"boolean","example":true,"default":true},"apollo_everywhere_search_count":{"type":"integer","example":0,"default":0}}}},"num_fetch_result":{}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/users/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"},"Check Apollo pricing plan":{"value":"{\n \"message\": \"This endpoint is only available to Apollo users on paid plans.\"\n}"}},"schema":{"oneOf":[{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/users/search is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}},{"title":"Check Apollo pricing plan","type":"object","properties":{"message":{"type":"string","example":"This endpoint is only available to Apollo users on paid plans."}}}]}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/users/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/users/search is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/users/api_profile":{"get":{"summary":"Get Current User Profile","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUsers are the people who use your Apollo workspace.

Use the Get Current User Profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.

By default, the endpoint returns the user's identity fields. Set the `include_credit_usage` query parameter to `true` to also return the user's and team's credit usage and remaining credit balances.

If you call this endpoint without valid access credentials, you receive a `401` response.","operationId":"get-current-user-profile","parameters":[{"name":"include_credit_usage","in":"query","description":"Set to `true` to include credit usage and remaining credit details (lead, direct dial, export, AI, and power-up credits) in the response. Accepts boolean (`true`/`false`) or string (`\"true\"`/`\"false\"`) values. Defaults to `false`.

Example: `true`","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Without credit usage":{"value":"{\n \"id\": \"66c8db577ed7f201b25c0eef\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"title\": \"Developer\",\n \"email\": \"john.doe@example.com\"\n}"},"With credit usage":{"value":"{\n \"id\": \"66c8db577ed7f201b25c0eef\",\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"title\": \"Developer\",\n \"email\": \"john.doe@example.com\",\n \"num_credits_remaining\": 9500,\n \"effective_num_lead_credits\": 10000,\n \"num_lead_credits_used\": 500,\n \"effective_num_direct_dial_credits\": 1000,\n \"num_direct_dial_credits_used\": 120,\n \"effective_num_export_credits\": 5000,\n \"num_export_credits_used\": 250,\n \"effective_num_ai_credits\": 2000,\n \"num_ai_credits_used\": 75,\n \"effective_num_power_up_credits\": 1000,\n \"num_power_up_credits_used\": 40,\n \"total_unified_credits_used\": 910\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"66c8db577ed7f201b25c0eef"},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"title":{"type":"string","example":"Developer"},"email":{"type":"string","example":"john.doe@example.com"},"num_credits_remaining":{"type":"integer","example":9500,"description":"Remaining lead credits for the user. Only present when `include_credit_usage=true`."},"effective_num_lead_credits":{"type":"integer","example":10000,"description":"Effective lead credit allowance for the user. Only present when `include_credit_usage=true`."},"num_lead_credits_used":{"type":"integer","example":500,"description":"Lead credits used by the user. Only present when `include_credit_usage=true`."},"effective_num_direct_dial_credits":{"type":"integer","example":1000,"description":"Effective direct dial credit allowance for the user. Only present when `include_credit_usage=true`."},"num_direct_dial_credits_used":{"type":"integer","example":120,"description":"Direct dial credits used by the user. Only present when `include_credit_usage=true`."},"effective_num_export_credits":{"type":"integer","example":5000,"description":"Effective export credit allowance for the user. Only present when `include_credit_usage=true`."},"num_export_credits_used":{"type":"integer","example":250,"description":"Export credits used by the user. Only present when `include_credit_usage=true`."},"effective_num_ai_credits":{"type":"integer","example":2000,"description":"Effective AI credit allowance for the user. Only present when `include_credit_usage=true`."},"num_ai_credits_used":{"type":"integer","example":75,"description":"AI credits used by the user. Only present when `include_credit_usage=true`."},"effective_num_power_up_credits":{"type":"integer","example":1000,"description":"Effective power-up credit allowance for the team. Only present when `include_credit_usage=true`."},"num_power_up_credits_used":{"type":"integer","example":40,"description":"Power-up credits used (user this cycle on unified credits, otherwise team total). Only present when `include_credit_usage=true`."},"total_unified_credits_used":{"type":"integer","example":910,"description":"Sum of lead, direct dial, export, and power-up credits used. Only present when `include_credit_usage=true` and the team is on unified credits."}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}}},"deprecated":false}},"/email_accounts":{"get":{"summary":"Get a List of Email Accounts","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nYou can link mailboxes to Apollo, and use them for prospect outreach.

Use the Get a List of Email Accounts endpoint to retrieve information about the linked email inboxes that your teammates use in your Apollo account.

In particular, this endpoint returns IDs for each of your team's linked email accounts, which can be used with the Add Contacts to a Sequence endpoint.

This endpoint doesn't require any parameters.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Miscellaneous"],"operationId":"get-a-list-of-email-accounts","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"email_accounts\": [\n {\n \"aliases\": [\n \"test.liam@apollomail.io\"\n ],\n \"id\": \"6630ffa2a7f52601c7578345\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"email\": \"test.liam@apollomail.io\",\n \"type\": \"gmail\",\n \"active\": true,\n \"default\": true,\n \"seconds_delay_between_emails\": 600,\n \"provider_display_name\": \"Gmail\",\n \"nylas_provider\": null,\n \"last_synced_at\": \"2024-09-19T18:50:45.088+00:00\",\n \"email_sending_policy_cd\": \"default\",\n \"sendgrid_api_user\": null,\n \"mailgun_domains\": null,\n \"nylas_api_version\": null,\n \"signature_edit_disabled\": false,\n \"revoked_at\": null,\n \"inactive_reason\": null,\n \"created_at\": \"2024-04-30T14:26:42.061Z\",\n \"sendgrid_api_key_v3\": null,\n \"email_daily_threshold\": 50,\n \"deliverability_score\": {\n \"_id\": \"66de4138d8a8a300016b404e\",\n \"avg_click_rate\": 0,\n \"avg_daily_sent\": 0,\n \"avg_delivered_rate\": 0,\n \"avg_hard_bounce_rate\": 0,\n \"avg_open_rate\": 0,\n \"avg_reply_rate\": 0,\n \"avg_spam_block_rate\": 0,\n \"avg_unsubscribe_rate\": 0,\n \"click_rate_score\": 0,\n \"concurrency_locks\": null,\n \"created_at\": \"2024-09-09T00:28:41.695Z\",\n \"daily_email_sent_score\": 0,\n \"date_from\": \"2024-09-09\",\n \"date_to\": \"2024-09-15\",\n \"deliverability_score\": 0,\n \"domain_health_score\": 5,\n \"email_account_domain_age_score\": 5,\n \"email_account_id\": \"6630ffa2a7f52601c7578345\",\n \"hard_bounce_score\": 0,\n \"open_rate_score\": 0,\n \"random\": 0.6074748,\n \"reply_rate_score\": 0,\n \"spam_block_score\": 0,\n \"sum_clicked_count\": 0,\n \"sum_delivered_count\": 0,\n \"sum_hard_bounced_count\": 0,\n \"sum_opened_count\": 0,\n \"sum_replied_count\": 0,\n \"sum_sent_count\": 0,\n \"sum_spam_blocked_count\": 0,\n \"sum_unsubscribed_count\": 0,\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"unsubscribe_rate_score\": 0,\n \"updated_at\": \"2024-09-09T00:28:41.695Z\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"id\": \"66de4138d8a8a300016b404e\",\n \"key\": \"66de4138d8a8a300016b404e\"\n },\n \"max_outbound_emails_per_hour\": 6,\n \"limits_editable\": true,\n \"is_opted_in_mailwarming\": null,\n \"mailwarming_max\": 0,\n \"mailwarming_to_send_daily\": 0,\n \"mailwarming_to_send_incrementor\": 0,\n \"mailwarming_status\": \"never_started\",\n \"mailwarming_eta\": null,\n \"mailwarming_subject_token\": null,\n \"mailwarming_score\": 0,\n \"mailwarming_score_banner\": \"start_warm_up_for_score\",\n \"mailwarming_on_weekdays_only\": true,\n \"true_warmup_enabled\": false,\n \"true_warmup_daily_limit\": 0,\n \"true_warmup_progress\": 0,\n \"true_warmup_status\": null,\n \"true_warmup_approximate_end_date\": null,\n \"true_warmup_last_throttled_at\": null,\n \"true_warmup_enable_thresholds\": false,\n \"true_warmup_thresholds\": {\n \"open_rate\": 20,\n \"reply_rate\": 1,\n \"bounce_rate\": 1,\n \"spam_block_rate\": 1\n },\n \"active_campaigns_count\": 2,\n \"nudge_user_to_send_mails\": true,\n \"signature_html\": \"
Liam Donovan
Apollo Academy Sales Instructor
liam.donovan@apollo.io

Apollo Knowledge Base

Book time to meet with me here.
\",\n \"fields_fully_loaded\": true\n },\n {\n \"aliases\": [\n \"test.dana@apollomail.io\"\n ],\n \"id\": \"6631066fab78f601c7b0a8bf\",\n \"user_id\": \"663027d1d03b9606c1934335\",\n \"email\": \"test.dana@apollomail.io\",\n \"type\": \"gmail\",\n \"active\": true,\n \"default\": true,\n \"seconds_delay_between_emails\": 500,\n \"provider_display_name\": \"Gmail\",\n \"nylas_provider\": null,\n \"last_synced_at\": \"2024-09-19T18:49:21.990+00:00\",\n \"email_sending_policy_cd\": \"default\",\n \"sendgrid_api_user\": null,\n \"mailgun_domains\": null,\n \"nylas_api_version\": null,\n \"signature_edit_disabled\": false,\n \"revoked_at\": null,\n \"inactive_reason\": null,\n \"created_at\": \"2024-04-30T14:55:43.556Z\",\n \"sendgrid_api_key_v3\": null,\n \"email_daily_threshold\": 50,\n \"deliverability_score\": {\n \"_id\": \"66de40f0d8a8a300016b4014\",\n \"avg_click_rate\": 0,\n \"avg_daily_sent\": 0,\n \"avg_delivered_rate\": 0,\n \"avg_hard_bounce_rate\": 0,\n \"avg_open_rate\": 0,\n \"avg_reply_rate\": 0,\n \"avg_spam_block_rate\": 0,\n \"avg_unsubscribe_rate\": 0,\n \"click_rate_score\": 0,\n \"concurrency_locks\": null,\n \"created_at\": \"2024-09-09T00:27:28.539Z\",\n \"daily_email_sent_score\": 0,\n \"date_from\": \"2024-09-09\",\n \"date_to\": \"2024-09-15\",\n \"deliverability_score\": 0,\n \"domain_health_score\": 5,\n \"email_account_domain_age_score\": 5,\n \"email_account_id\": \"6631066fab78f601c7b0a8bf\",\n \"hard_bounce_score\": 0,\n \"open_rate_score\": 0,\n \"random\": 0.64551977,\n \"reply_rate_score\": 0,\n \"spam_block_score\": 0,\n \"sum_clicked_count\": 0,\n \"sum_delivered_count\": 0,\n \"sum_hard_bounced_count\": 0,\n \"sum_opened_count\": 0,\n \"sum_replied_count\": 0,\n \"sum_sent_count\": 0,\n \"sum_spam_blocked_count\": 0,\n \"sum_unsubscribed_count\": 0,\n \"team_id\": \"6095a710bd01d100a506d4ac\",\n \"unsubscribe_rate_score\": 0,\n \"updated_at\": \"2024-09-09T00:27:28.539Z\",\n \"user_id\": \"663027d1d03b9606c1934335\",\n \"id\": \"66de40f0d8a8a300016b4014\",\n \"key\": \"66de40f0d8a8a300016b4014\"\n },\n \"max_outbound_emails_per_hour\": 6,\n \"limits_editable\": true,\n \"is_opted_in_mailwarming\": null,\n \"mailwarming_max\": 0,\n \"mailwarming_to_send_daily\": 0,\n \"mailwarming_to_send_incrementor\": 0,\n \"mailwarming_status\": \"never_started\",\n \"mailwarming_eta\": null,\n \"mailwarming_subject_token\": null,\n \"mailwarming_score\": 0,\n \"mailwarming_score_banner\": \"start_warm_up_for_score\",\n \"mailwarming_on_weekdays_only\": true,\n \"true_warmup_enabled\": false,\n \"true_warmup_daily_limit\": 0,\n \"true_warmup_progress\": 0,\n \"true_warmup_status\": null,\n \"true_warmup_approximate_end_date\": null,\n \"true_warmup_last_throttled_at\": null,\n \"true_warmup_enable_thresholds\": false,\n \"true_warmup_thresholds\": {\n \"open_rate\": 20,\n \"reply_rate\": 1,\n \"bounce_rate\": 1,\n \"spam_block_rate\": 1\n },\n \"active_campaigns_count\": 2,\n \"nudge_user_to_send_mails\": true,\n \"signature_html\": \"
Janet Testing
Apollo Knowledge Base
\",\n \"fields_fully_loaded\": true\n }\n ]\n}"}},"schema":{"type":"object","properties":{"email_accounts":{"type":"array","items":{"type":"object","properties":{"aliases":{"type":"array","items":{"type":"string","example":"test.liam@apollomail.io"}},"id":{"type":"string","example":"6630ffa2a7f52601c7578345"},"user_id":{"type":"string","example":"66302798d03b9601c7934ebc"},"email":{"type":"string","example":"test.liam@apollomail.io"},"type":{"type":"string","example":"gmail"},"active":{"type":"boolean","example":true,"default":true},"default":{"type":"boolean","example":true,"default":true},"seconds_delay_between_emails":{"type":"integer","example":600,"default":0},"provider_display_name":{"type":"string","example":"Gmail"},"nylas_provider":{},"last_synced_at":{"type":"string","example":"2024-09-19T18:50:45.088+00:00"},"email_sending_policy_cd":{"type":"string","example":"default"},"sendgrid_api_user":{},"mailgun_domains":{},"nylas_api_version":{},"signature_edit_disabled":{"type":"boolean","example":false,"default":true},"revoked_at":{},"inactive_reason":{},"created_at":{"type":"string","example":"2024-04-30T14:26:42.061Z"},"sendgrid_api_key_v3":{},"email_daily_threshold":{"type":"integer","example":50,"default":0},"deliverability_score":{"type":"object","properties":{"_id":{"type":"string","example":"66de4138d8a8a300016b404e"},"avg_click_rate":{"type":"integer","example":0,"default":0},"avg_daily_sent":{"type":"integer","example":0,"default":0},"avg_delivered_rate":{"type":"integer","example":0,"default":0},"avg_hard_bounce_rate":{"type":"integer","example":0,"default":0},"avg_open_rate":{"type":"integer","example":0,"default":0},"avg_reply_rate":{"type":"integer","example":0,"default":0},"avg_spam_block_rate":{"type":"integer","example":0,"default":0},"avg_unsubscribe_rate":{"type":"integer","example":0,"default":0},"click_rate_score":{"type":"integer","example":0,"default":0},"concurrency_locks":{},"created_at":{"type":"string","example":"2024-09-09T00:28:41.695Z"},"daily_email_sent_score":{"type":"integer","example":0,"default":0},"date_from":{"type":"string","example":"2024-09-09"},"date_to":{"type":"string","example":"2024-09-15"},"deliverability_score":{"type":"integer","example":0,"default":0},"domain_health_score":{"type":"integer","example":5,"default":0},"email_account_domain_age_score":{"type":"integer","example":5,"default":0},"email_account_id":{"type":"string","example":"6630ffa2a7f52601c7578345"},"hard_bounce_score":{"type":"integer","example":0,"default":0},"open_rate_score":{"type":"integer","example":0,"default":0},"random":{"type":"number","example":0.6074748,"default":0},"reply_rate_score":{"type":"integer","example":0,"default":0},"spam_block_score":{"type":"integer","example":0,"default":0},"sum_clicked_count":{"type":"integer","example":0,"default":0},"sum_delivered_count":{"type":"integer","example":0,"default":0},"sum_hard_bounced_count":{"type":"integer","example":0,"default":0},"sum_opened_count":{"type":"integer","example":0,"default":0},"sum_replied_count":{"type":"integer","example":0,"default":0},"sum_sent_count":{"type":"integer","example":0,"default":0},"sum_spam_blocked_count":{"type":"integer","example":0,"default":0},"sum_unsubscribed_count":{"type":"integer","example":0,"default":0},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"unsubscribe_rate_score":{"type":"integer","example":0,"default":0},"updated_at":{"type":"string","example":"2024-09-09T00:28:41.695Z"},"user_id":{"type":"string","example":"66302798d03b9601c7934ebc"},"id":{"type":"string","example":"66de4138d8a8a300016b404e"},"key":{"type":"string","example":"66de4138d8a8a300016b404e"}}},"max_outbound_emails_per_hour":{"type":"integer","example":6,"default":0},"limits_editable":{"type":"boolean","example":true,"default":true},"is_opted_in_mailwarming":{},"mailwarming_max":{"type":"integer","example":0,"default":0},"mailwarming_to_send_daily":{"type":"integer","example":0,"default":0},"mailwarming_to_send_incrementor":{"type":"integer","example":0,"default":0},"mailwarming_status":{"type":"string","example":"never_started"},"mailwarming_eta":{},"mailwarming_subject_token":{},"mailwarming_score":{"type":"integer","example":0,"default":0},"mailwarming_score_banner":{"type":"string","example":"start_warm_up_for_score"},"mailwarming_on_weekdays_only":{"type":"boolean","example":true,"default":true},"true_warmup_enabled":{"type":"boolean","example":false,"default":true},"true_warmup_daily_limit":{"type":"integer","example":0,"default":0},"true_warmup_progress":{"type":"integer","example":0,"default":0},"true_warmup_status":{},"true_warmup_approximate_end_date":{},"true_warmup_last_throttled_at":{},"true_warmup_enable_thresholds":{"type":"boolean","example":false,"default":true},"true_warmup_thresholds":{"type":"object","properties":{"open_rate":{"type":"integer","example":20,"default":0},"reply_rate":{"type":"integer","example":1,"default":0},"bounce_rate":{"type":"integer","example":1,"default":0},"spam_block_rate":{"type":"integer","example":1,"default":0}}},"active_campaigns_count":{"type":"integer","example":2,"default":0},"nudge_user_to_send_mails":{"type":"boolean","example":true,"default":true},"signature_html":{"type":"string","example":"
Liam Donovan
Apollo Academy Sales Instructor
liam.donovan@apollo.io

Apollo Knowledge Base

Book time to meet with me here.
"},"fields_fully_loaded":{"type":"boolean","example":true,"default":true}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/email_accounts/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/email_accounts/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/email_accounts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/email_accounts is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/labels":{"get":{"summary":"Get a List of All Lists","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Get a List of All Lists endpoint to retrieve information about every list that has been created in your Apollo account. This endpoint can be used to check the available lists before you use the Create a Contact endpoint.

This endpoint doesn't require any parameters.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Miscellaneous"],"operationId":"get-a-list-of-all-lists","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":[{"_id":"66e9e215ece19801b2199981","cached_count":1,"concurrency_locks":{},"created_at":"2024-09-17T20:09:57.863Z","modality":"emailer_campaigns","name":"Dublin market","need_cached_count_update":false,"needs_count_update_at":"2024-09-17T20:09:57.885+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-09-17T20:09:57.910Z","user_id":"66302798d03b9601c7934ebf","id":"66e9e215ece19801b2199981","key":"66e9e215ece19801b2199981"},{"_id":"6660862c078cf0038abedb64","cached_count":25,"concurrency_locks":{},"created_at":"2024-06-05T15:37:16.684Z","modality":"contacts","name":"Conference 2024 - Maui","need_cached_count_update":false,"needs_count_update_at":"2024-06-05T15:37:16.708+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-06-05T15:37:16.738Z","user_id":"66302798d03b9601c7934ec2","id":"6660862c078cf0038abedb64","key":"6660862c078cf0038abedb64"},{"_id":"66e361494acd1307386d4073","cached_count":0,"concurrency_locks":{},"created_at":"2024-09-12T21:46:49.464Z","modality":"contacts","name":"2024 fiction writers of america attendees","need_cached_count_update":false,"needs_count_update_at":"2024-09-13T00:43:17.703+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-09-13T00:47:35.416Z","user_id":"60affe7d6e270a00f5db6fe4","id":"66e361494acd1307386d4073","key":"66e361494acd1307386d4073"},{"_id":"66ad0f4bc1a9d50001765e61","cached_count":11,"concurrency_locks":{},"created_at":"2024-08-02T16:54:35.303Z","modality":"contacts","name":"Demo Meeting Booked","need_cached_count_update":false,"needs_count_update_at":"2024-09-17T22:44:30.338+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-09-17T22:44:30.370Z","user_id":"6578a336d8ecfd03eca315d8","id":"66ad0f4bc1a9d50001765e61","key":"66ad0f4bc1a9d50001765e61"},{"_id":"660333cbb93a2102e8f00331","cached_count":83,"concurrency_locks":{},"created_at":"2024-03-26T20:44:59.053Z","modality":"contacts","name":"Trade Show Leads","need_cached_count_update":false,"needs_count_update_at":"2024-03-26T20:45:03.106+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-03-26T20:45:03.139Z","user_id":"60affe7d6e270a00f5db6fe4","id":"660333cbb93a2102e8f00331","key":"660333cbb93a2102e8f00331"},{"_id":"6614710916c22b01c7dd5e9b","cached_count":8,"concurrency_locks":{},"created_at":"2024-04-08T22:34:49.454Z","modality":"accounts","name":"CSV Import","need_cached_count_update":false,"needs_count_update_at":"2024-04-08T22:34:49.489+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-04-08T22:37:23.037Z","user_id":"60affe7d6e270a00f5db6fe4","id":"6614710916c22b01c7dd5e9b","key":"6614710916c22b01c7dd5e9b"},{"_id":"6625244b0909d600078ad116","cached_count":229,"concurrency_locks":{},"created_at":"2024-04-21T14:35:55.672Z","modality":"contacts","name":"Cold Call Leads","need_cached_count_update":false,"needs_count_update_at":"2024-05-21T21:11:06.074+00:00","rule_config_template_id":null,"team_id":"6095a710bd01d100a506d4ac","updated_at":"2024-05-21T21:11:06.106Z","user_id":"60affe7d6e270a00f5db6fe4","id":"6625244b0909d600078ad116","key":"6625244b0909d600078ad116"}]}},"schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"66e9e215ece19801b2199981"},"cached_count":{"type":"integer","example":1,"default":0},"concurrency_locks":{"type":"object","properties":{}},"created_at":{"type":"string","example":"2024-09-17T20:09:57.863Z"},"modality":{"type":"string","example":"emailer_campaigns"},"name":{"type":"string","example":"Dublin market"},"need_cached_count_update":{"type":"boolean","example":false,"default":true},"needs_count_update_at":{"type":"string","example":"2024-09-17T20:09:57.885+00:00"},"rule_config_template_id":{},"team_id":{"type":"string","example":"6095a710bd01d100a506d4ac"},"updated_at":{"type":"string","example":"2024-09-17T20:09:57.910Z"},"user_id":{"type":"string","example":"66302798d03b9601c7934ebf"},"id":{"type":"string","example":"66e9e215ece19801b2199981"},"key":{"type":"string","example":"66e9e215ece19801b2199981"}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/labels/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/labels/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/labels is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/labels is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}},"deprecated":false}},"/fields":{"get":{"summary":"Get a List of Fields","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Get a List of Fields endpoint to retrieve information about all of the fields that exist in your Apollo account.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Miscellaneous"],"operationId":"get-a-list-of-fields","parameters":[{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["system","custom","crm_synced"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"fields":[{"id":"contact.id","category":"person","context":["finder","csv_export"],"description":null,"editable":false,"example":"673c929202c6025d8bc4e680","field_name":"contact.id","group":"basic_info","icon_class":"user","label":"Identifier","modality":"contact","parent":null,"source":"system","type":"string","finder_view_ids":[],"project_workspace_id":null,"finder_views":[],"is_local":false},{"id":"contact.attr1","category":"person","context":["finder","csv_export"],"description":null,"editable":false,"example":"Test Corp","field_name":"contact.attr1","group":"basic_info","icon_class":"company","label":"Person","modality":"contact","parent":null,"source":"system","type":"association","finder_view_ids":[],"project_workspace_id":null,"finder_views":[],"is_local":false},{"id":"contact.attr2","category":"person","context":["prompt","formula","snippets","finder"],"description":null,"editable":false,"example":"John","field_name":"contact.attr2","group":"basic_info","icon_class":"user","label":"First name","modality":"contact","parent":"contact.name","source":"system","type":"string","finder_view_ids":[],"project_workspace_id":null,"finder_views":[],"is_local":false},{"id":"account.694095a80f1b6000110fc556","category":"company","context":["csv_export","finder","prompt"],"description":null,"editable":false,"example":null,"field_name":"Custom field name","group":null,"icon_class":null,"label":"last name","modality":"account","parent":"account.other_custom_field","source":"custom","type":"string","finder_view_ids":[],"project_workspace_id":null,"finder_views":[],"is_local":false,"created_at":"2025-12-15T23:11:36.084Z"}]}}},"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"modality":{"type":"string","description":"Entity type this field belongs to (contact, account, opportunity, lead, custom_object)"},"context":{"type":"string","description":"High‑level context for the field (contact, account, opportunity, lead, custom_object)"},"type":{"type":"string","description":"Field data type (text, number, date, datetime, boolean, picklist, multi_select, url, email, phone, currency)"},"source":{"type":"string","description":"Field source (system, custom, crm_synced)"},"project_workspace_id":{"type":"string"},"meta":{"type":"object","additionalProperties":true,"description":"Extended configuration for the field"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","label","modality","type"]}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/fields/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/fields/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of API calls allowed for api/v1/fields is 600 times per hour. To change your rate limit, upgrade your Apollo plan at https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of API calls allowed for api/v1/fields is 600 times per hour. To change your rate limit, upgrade your Apollo plan at https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}},"post":{"summary":"Create a Custom Field","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nThe Create a Custom Field endpoint lets you add custom fields to your Apollo account, helping your team capture unique details with custom contact, custom account, or custom deal fields.

Use these fields to enhance your sequences and deliver more personalized, relevant outreach.","tags":["Miscellaneous"],"operationId":"create-a-custom-field","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"Name of the custom field you want to create. Example: `Test Name`"},"modality":{"type":"string","description":"The modality of the custom field you want to create. Example: `contact`","enum":["contact","account","opportunity"]},"type":{"type":"string","description":"What kind of custom field you want to create. Example: `textarea`","enum":["string","textarea","number","date","datetime","boolean"]},"meta":{"type":"object","properties":{"max_length":{"type":"number"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"typed_custom_fields":[{"id":"32d42c92-5be4-4ec4-96c7-f689b43ec8a8","name":"Test Name","modality":"contact","text_field_max_length":120}]}}},"schema":{"type":"object","properties":{"typed_custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"32d42c92-5be4-4ec4-96c7-f689b43ec8a8"},"name":{"type":"string","example":"Test Name"},"modality":{"type":"string","example":"contact"},"text_field_max_length":{"type":"number","example":120}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/fields this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/fields is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}}},"deprecated":false}},"/typed_custom_fields":{"get":{"deprecated":true,"summary":"Get a List of All Custom Fields","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nThis endpoint is deprecated. To achieve the same result, use the Fields endpoint (use `source: custom` to get custom fields only).

Use the Get a List of Custom Fields endpoint to retrieve information about all of the custom fields that have been created in your Apollo account.

This endpoint doesn't require any parameters.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Miscellaneous"],"operationId":"get-a-list-of-all-custom-fields","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"typed_custom_fields\": [\n {\n \"id\": \"60c39ed82bd02f01154c470a\",\n \"modality\": \"contact\",\n \"name\": \"New Product Launch Date\",\n \"type\": \"datetime\",\n \"picklist_options\": [],\n \"mapped_crm_field\": null,\n \"additional_mapped_crm_field\": null,\n \"is_readonly_mapped_crm_field\": null,\n \"picklist_options_last_synced_at\": \"2021-06-11T17:35:12.000+00:00\",\n \"picklist_value_set_id\": null,\n \"mirrored\": false,\n \"system_name\": null,\n \"text_field_max_length\": null,\n \"finder_view_ids\": [],\n \"is_local\": false\n },\n {\n \"id\": \"617ff4041e711500a401c25e\",\n \"modality\": \"contact\",\n \"name\": \"Customer Age\",\n \"type\": \"picklist\",\n \"picklist_options\": [],\n \"mapped_crm_field\": null,\n \"additional_mapped_crm_field\": null,\n \"is_readonly_mapped_crm_field\": null,\n \"picklist_options_last_synced_at\": \"2021-11-01T14:02:48.000+00:00\",\n \"picklist_value_set_id\": \"61117d862f006400da5bf2e4\",\n \"mirrored\": false,\n \"system_name\": null,\n \"text_field_max_length\": null,\n \"finder_view_ids\": [],\n \"is_local\": false,\n \"picklist_values\": [\n {\n \"_id\": \"617ff4041e711500a401c25f\",\n \"mapped_crm_values\": {},\n \"name\": \"New Customer\",\n \"id\": \"617ff4041e711500a401c25f\",\n \"key\": \"617ff4041e711500a401c25f\"\n },\n {\n \"_id\": \"617ff4041e711500a401c260\",\n \"mapped_crm_values\": {},\n \"name\": \"1 year\",\n \"id\": \"617ff4041e711500a401c260\",\n \"key\": \"617ff4041e711500a401c260\"\n },\n {\n \"_id\": \"617ff4041e711500a401c261\",\n \"mapped_crm_values\": {},\n \"name\": \"2 years\",\n \"id\": \"617ff4041e711500a401c261\",\n \"key\": \"617ff4041e711500a401c261\"\n },\n {\n \"_id\": \"617ff4041e711500a401c262\",\n \"mapped_crm_values\": {},\n \"name\": \"3 years\",\n \"id\": \"617ff4041e711500a401c262\",\n \"key\": \"617ff4041e711500a401c262\"\n },\n {\n \"_id\": \"617ff4041e711500a401c263\",\n \"mapped_crm_values\": {},\n \"name\": \"Longterm\",\n \"id\": \"617ff4041e711500a401c263\",\n \"key\": \"617ff4041e711500a401c263\"\n }\n ]\n },\n {\n \"id\": \"6462b86c1a511900a3f3a30d\",\n \"modality\": \"contact\",\n \"name\": \"Lead Source\",\n \"type\": \"picklist\",\n \"picklist_options\": [],\n \"mapped_crm_field\": null,\n \"additional_mapped_crm_field\": null,\n \"is_readonly_mapped_crm_field\": true,\n \"picklist_options_last_synced_at\": \"2024-04-10T08:30:46.185+00:00\",\n \"picklist_value_set_id\": \"6462b86c1a511900a3f3a317\",\n \"mirrored\": false,\n \"system_name\": null,\n \"text_field_max_length\": null,\n \"finder_view_ids\": [],\n \"is_local\": false,\n \"picklist_values\": [\n {\n \"_id\": \"6462b86c1a511900a3f3a30e\",\n \"mapped_crm_values\": {},\n \"name\": \"Organic Search\",\n \"id\": \"6462b86c1a511900a3f3a30e\",\n \"key\": \"6462b86c1a511900a3f3a30e\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a30f\",\n \"mapped_crm_values\": {},\n \"name\": \"Paid Search\",\n \"id\": \"6462b86c1a511900a3f3a30f\",\n \"key\": \"6462b86c1a511900a3f3a30f\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a310\",\n \"mapped_crm_values\": {},\n \"name\": \"Email Marketing\",\n \"id\": \"6462b86c1a511900a3f3a310\",\n \"key\": \"6462b86c1a511900a3f3a310\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a311\",\n \"mapped_crm_values\": {},\n \"name\": \"Organic Social\",\n \"id\": \"6462b86c1a511900a3f3a311\",\n \"key\": \"6462b86c1a511900a3f3a311\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a312\",\n \"mapped_crm_values\": {},\n \"name\": \"Referrals\",\n \"id\": \"6462b86c1a511900a3f3a312\",\n \"key\": \"6462b86c1a511900a3f3a312\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a313\",\n \"mapped_crm_values\": {},\n \"name\": \"Other Campaigns\",\n \"id\": \"6462b86c1a511900a3f3a313\",\n \"key\": \"6462b86c1a511900a3f3a313\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a314\",\n \"mapped_crm_values\": {},\n \"name\": \"Direct Traffic\",\n \"id\": \"6462b86c1a511900a3f3a314\",\n \"key\": \"6462b86c1a511900a3f3a314\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a315\",\n \"mapped_crm_values\": {},\n \"name\": \"Offline Sources\",\n \"id\": \"6462b86c1a511900a3f3a315\",\n \"key\": \"6462b86c1a511900a3f3a315\"\n },\n {\n \"_id\": \"6462b86c1a511900a3f3a316\",\n \"mapped_crm_values\": {},\n \"name\": \"Paid Social\",\n \"id\": \"6462b86c1a511900a3f3a316\",\n \"key\": \"6462b86c1a511900a3f3a316\"\n },\n {\n \"_id\": \"6462b92fad39c900a3070100\",\n \"mapped_crm_values\": {},\n \"name\": \"Inbound\",\n \"id\": \"6462b92fad39c900a3070100\",\n \"key\": \"6462b92fad39c900a3070100\"\n }\n ]\n },\n {\n \"id\": \"64e3a392038e3000a3beebcf\",\n \"modality\": \"contact\",\n \"name\": \"Last Engagement Type\",\n \"type\": \"picklist\",\n \"picklist_options\": [],\n \"mapped_crm_field\": null,\n \"additional_mapped_crm_field\": null,\n \"is_readonly_mapped_crm_field\": true,\n \"picklist_options_last_synced_at\": \"2024-04-10T08:30:46.185+00:00\",\n \"picklist_value_set_id\": \"64e3a392038e3000a3beebd8\",\n \"mirrored\": false,\n \"system_name\": null,\n \"text_field_max_length\": null,\n \"finder_view_ids\": [],\n \"is_local\": false,\n \"picklist_values\": [\n {\n \"_id\": \"64e3a392038e3000a3beebd0\",\n \"mapped_crm_values\": {},\n \"name\": \"Company Website Visit\",\n \"id\": \"64e3a392038e3000a3beebd0\",\n \"key\": \"64e3a392038e3000a3beebd0\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd1\",\n \"mapped_crm_values\": {},\n \"name\": \"Document View\",\n \"id\": \"64e3a392038e3000a3beebd1\",\n \"key\": \"64e3a392038e3000a3beebd1\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd2\",\n \"mapped_crm_values\": {},\n \"name\": \"Email Click\",\n \"id\": \"64e3a392038e3000a3beebd2\",\n \"key\": \"64e3a392038e3000a3beebd2\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd3\",\n \"mapped_crm_values\": {},\n \"name\": \"Email Open\",\n \"id\": \"64e3a392038e3000a3beebd3\",\n \"key\": \"64e3a392038e3000a3beebd3\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd4\",\n \"mapped_crm_values\": {},\n \"name\": \"Email Reply\",\n \"id\": \"64e3a392038e3000a3beebd4\",\n \"key\": \"64e3a392038e3000a3beebd4\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd5\",\n \"mapped_crm_values\": {},\n \"name\": \"Form Submitted\",\n \"id\": \"64e3a392038e3000a3beebd5\",\n \"key\": \"64e3a392038e3000a3beebd5\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd6\",\n \"mapped_crm_values\": {},\n \"name\": \"Meeting Booked\",\n \"id\": \"64e3a392038e3000a3beebd6\",\n \"key\": \"64e3a392038e3000a3beebd6\"\n },\n {\n \"_id\": \"64e3a392038e3000a3beebd7\",\n \"mapped_crm_values\": {},\n \"name\": \"Website Visit\",\n \"id\": \"64e3a392038e3000a3beebd7\",\n \"key\": \"64e3a392038e3000a3beebd7\"\n }\n ]\n }\n ]\n}"}},"schema":{"type":"object","properties":{"typed_custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"60c39ed82bd02f01154c470a"},"modality":{"type":"string","example":"contact"},"name":{"type":"string","example":"New Product Launch Date"},"type":{"type":"string","example":"datetime"},"picklist_options":{"type":"array"},"mapped_crm_field":{},"additional_mapped_crm_field":{},"is_readonly_mapped_crm_field":{},"picklist_options_last_synced_at":{"type":"string","example":"2021-06-11T17:35:12.000+00:00"},"picklist_value_set_id":{},"mirrored":{"type":"boolean","example":false,"default":true},"system_name":{},"text_field_max_length":{},"finder_view_ids":{"type":"array"},"is_local":{"type":"boolean","example":false,"default":true}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/typed_custom_fields/index is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"api/v1/typed_custom_fields/index is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/typed_custom_fields is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/typed_custom_fields is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}}},"/organizations/{id}":{"get":{"summary":"Get Complete Organization Info","description":"This endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nOrganizations are companies you haven't yet saved as accounts on Apollo.

Use the Get Complete Organization Info endpoint to retrieve complete details about an organization in Apollo.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Search"],"operationId":"get_organizations{id}","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"value":{"organization":{"id":"5e66b6381e05b4008c8331b8","name":"Apollo.io","website_url":"http://www.apollo.io","linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/MeetApollo/","facebook_url":"https://facebook.com/MeetApollo/","alexa_ranking":3514,"linkedin_uid":"18511550","founded_year":2015,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/b1bdd6009b1611149b56f0bc/picture","primary_domain":"apollo.io","industry":"information technology & services","estimated_num_employees":910,"keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data","software development","crm integration","data enrichment","deal management","pipeline management","automated workflows","analytics & reporting","coaching & feedback","signal-based prospecting","inbound optimization","contact & account search","email outreach automation","meeting scheduling","ai sales assistant","multi-channel outreach","lead qualification","form optimization","sales performance improvement","live data network","ai sales automation","revops tools","account-based prospecting","sales pipeline","meeting preparedness","ai recommendations","webinar integration","sales coaching","team collaboration","sales insights","buyer's journey tracking","market intelligence","lead prioritization","customer journey mapping","sales funnel tracking","data-driven sales","email deliverability management","automated lead follow-up","predictive analytics for sales","sales campaign management","sales productivity tools","sales performance management","b2b sales intelligence","ai-driven automation","prospecting tools","contact database","sales automation","email tracking","intent data","sales workflow management","advanced search filters","customer success","scalable solutions","sales analytics","outreach optimization","data-driven strategies","customer acquisition","sales productivity","marketing automation","user-friendly interface","comprehensive features","business growth","sales optimization","competitive advantage","market potential","sales teams","enterprise solutions","small business support","mid-market focus","diverse industries","customer demographics","sales intelligence platform","marketing & advertising","sales","information technology & services","enterprise software","enterprises","computer software","b2b","saas"],"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"535 mission street, san francisco, california, united states, 94105","street_address":"535 Mission Street","city":"San Francisco","state":"California","postal_code":"94105","country":"United States","owned_by_organization_id":null,"short_description":"Apollo.io is an AI sales platform that provides businesses with tools to enhance their go-to-market strategies. Founded in 2015 by Tim and Ray, the company was created to address the limitations of existing sales tools they encountered in their previous startup. Apollo.io offers an all-in-one platform that integrates lead intelligence and sales engagement capabilities, helping businesses find leads, engage prospects, and close deals more effectively.\n\nThe platform features detailed insights into potential customers, tools for managing leads from initial contact to deal closure, and a community-based approach to data accuracy. Apollo.io serves nearly 9,000 paying customers, including startups and large enterprises, and supports over 500,000 sales professionals globally. The company has experienced rapid growth, surpassing $100 million in annual recurring revenue and achieving a valuation of $1.6 billion. Apollo.io has also received funding from notable investors like Y Combinator and Nexus Venture Partners.","suborganizations":[],"num_suborganizations":0,"annual_revenue_printed":"100M","annual_revenue":100000000,"total_funding":251200000,"total_funding_printed":"251.2M","latest_funding_round_date":"2023-08-01T00:00:00.000+00:00","latest_funding_stage":"Series D","funding_events":[{"id":"6574c1ff9b797d0001fdab1b","date":"2023-08-01T00:00:00.000+00:00","news_url":null,"type":"Series D","investors":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners","amount":"100M","currency":"$"},{"id":"624f4dfec786590001768016","date":"2022-03-01T00:00:00.000+00:00","news_url":null,"type":"Series C","investors":"Sequoia Capital, Tribe Capital, Nexus Venture Partners, NewView Capital","amount":"110M","currency":"$"},{"id":"61b13677623110000186a478","date":"2021-10-01T00:00:00.000+00:00","news_url":null,"type":"Series B","investors":"Tribe Capital, NewView Capital, Nexus Venture Partners","amount":"32M","currency":"$"},{"id":"5ffe93caa54d75077c59acef","date":"2018-06-26T00:00:00.000+00:00","news_url":"https://techcrunch.com/2018/06/26/yc-grad-zenprospect-rebrands-as-apollo-lands-7-m-series-a/","type":"Series A","investors":"Nexus Venture Partners, Social Capital, Y Combinator","amount":"7M","currency":"$"},{"id":"6574c1ff9b797d0001fdab20","date":"2016-10-01T00:00:00.000+00:00","news_url":null,"type":"Other","investors":"Y Combinator, SV Angel, Social Capital, Nexus Venture Partners","amount":"2.2M","currency":"$"}],"technology_names":["AI","Android","Basis","Canva","Circle","CloudFlare Hosting","Cloudflare DNS","Drift","Gmail","Google Apps","Google Tag Manager","Google Workspace","Hubspot","Microsoft Office 365","Mobile Friendly","Python","Rackspace MailGun","Remote","Render","Reviews","Salesforce","SharePoint","Stripe","WP Engine","Webmail","Zendesk"],"current_technologies":[{"uid":"ai","name":"AI","category":"Other"},{"uid":"android","name":"Android","category":"Frameworks and Programming Languages"},{"uid":"basis","name":"Basis","category":"Advertising Networks"},{"uid":"canva","name":"Canva","category":"Content Management Platform"},{"uid":"circle","name":"Circle","category":"Financial Software"},{"uid":"cloudflare_hosting","name":"CloudFlare Hosting","category":"Hosting"},{"uid":"cloudflare_dns","name":"Cloudflare DNS","category":"Domain Name Services"},{"uid":"drift","name":"Drift","category":"Widgets"},{"uid":"gmail","name":"Gmail","category":"Email Providers"},{"uid":"google_apps","name":"Google Apps","category":"Other"},{"uid":"google_tag_manager","name":"Google Tag Manager","category":"Tag Management"},{"uid":"google workspace","name":"Google Workspace","category":"Cloud Services"},{"uid":"hubspot","name":"Hubspot","category":"Marketing Automation"},{"uid":"office_365","name":"Microsoft Office 365","category":"Other"},{"uid":"mobile_friendly","name":"Mobile Friendly","category":"Other"},{"uid":"python","name":"Python","category":"Frameworks and Programming Languages"},{"uid":"rackspace_mailgun","name":"Rackspace MailGun","category":"Email Delivery"},{"uid":"remote","name":"Remote","category":"Other"},{"uid":"render","name":"Render","category":"Other"},{"uid":"reviews","name":"Reviews","category":"Customer Reviews"},{"uid":"salesforce","name":"Salesforce","category":"Customer Relationship Management"},{"uid":"sharepoint","name":"SharePoint","category":"CMS"},{"uid":"stripe","name":"Stripe","category":"Payments"},{"uid":"wp_engine","name":"WP Engine","category":"CMS"},{"uid":"webmail","name":"Webmail","category":"Email Providers"},{"uid":"zendesk","name":"Zendesk","category":"Support and Feedback"}],"org_chart_root_people_ids":["66f6de0d74c57a00015d2b39"],"org_chart_sector":"OrgChart::SectorHierarchy::Rules::IT","org_chart_removed":false,"org_chart_show_department_filter":true,"account_id":"63f53afe4ceeca00016bdd47","account":{"id":"63f53afe4ceeca00016bdd47","domain":"apollo.io","name":"Apollo","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","source":"chrome_extension_linkedin","original_source":"salesforce","owner_id":"60affe7d6e270a00f5db6fe4","created_at":"2023-02-21T21:43:26.352Z","phone":"+1(202) 555-0114","phone_status":"no_status","sanitized_phone":"+12025550114","account_playbook_statuses":[],"existence_level":"full","label_ids":[],"typed_custom_fields":{},"custom_field_errors":{},"modality":"account","source_display_name":"Added from LinkedIn","crm_record_url":null,"intent_strength":null,"show_intent":false,"has_intent_signal_account":true,"intent_signal_account":{"_id":"6663bd946cef250001def02a","account_id":"6658955677a2f20001c647ad","aggregated_at":"2024-09-04T10:02:28.878+00:00","computed":true,"created_at":"2024-06-08T02:10:28.537Z","domain_aggregates":[{"domain":"tableofdiscontents.com","total_visits":15,"last_visit":20240611,"first_visit":20240607,"unique_visitors":6,"weekly_aggregates":[{"week_start_date":"2024-06-07T00:00:00.000Z","count":15}],"top_5_paths":[{"_id":"www.tableofdiscontents.com","total_visits":9},{"_id":"www.tableofdiscontents.com/pricing","total_visits":3},{"_id":"www.tableofdiscontents.com/premium","total_visits":2},{"_id":"www.tableofdiscontents.com/features","total_visits":1}],"intent":"low","intent_score":0}],"first_visited_at":20240607,"last_visited_at":20240611,"need_aggregation":false,"need_es_update":false,"new_reveal":false,"organization_id":"5e66b6381e05b4008c8331b8","overall_intent":"low","pre_generated_account_id":"6658955677a2f20001c647ad","random":0.162172829,"team_id":"6095a710bd01d100a506d4ac","team_org_id":"6095a710bd01d100a506d4ac_5e66b6381e05b4008c8331b8","total_visits":15,"unique_visitors":6,"updated_at":"2024-09-04T10:02:28.959Z","website_visitor_metrics":{"overall_intent":"low","total_visits":15,"unique_visitors":6,"domain_aggregates":[{"domain":"tableofdiscontents.com","first_intent_signal_received_at":20240607,"last_intent_signal_received_at":20240611}],"page_view_aggregates":{"one_day_count":0,"seven_day_count":0,"fifteen_day_count":0,"thirty_day_count":0,"sixty_day_count":0,"ninety_day_count":15},"pages":["www.tableofdiscontents.com","www.tableofdiscontents.com/pricing","www.tableofdiscontents.com/premium","www.tableofdiscontents.com/features"],"first_intent_signal_received_at":20240607,"last_intent_signal_received_at":20240611},"id":"6663bd946cef250001def02a","key":"6663bd946cef250001def02a"},"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null,"generic_org_insights":null},"employee_metrics":[{"start_date":"2023-05-01","departments":[{"functions":null,"new":0,"retained":97,"churned":0},{"functions":"accounting","new":0,"retained":1,"churned":0},{"functions":"sales","new":0,"retained":71,"churned":1},{"functions":"operations","new":0,"retained":21,"churned":0},{"functions":"finance","new":0,"retained":5,"churned":0},{"functions":"marketing","new":0,"retained":11,"churned":1},{"functions":"human_resources","new":0,"retained":21,"churned":0},{"functions":"legal","new":0,"retained":1,"churned":0},{"functions":"engineering","new":0,"retained":100,"churned":0},{"functions":"business_development","new":0,"retained":14,"churned":0},{"functions":"product_management","new":0,"retained":13,"churned":0},{"functions":"consulting","new":0,"retained":2,"churned":0},{"functions":"education","new":0,"retained":4,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":1,"churned":0},{"functions":"arts_and_design","new":0,"retained":7,"churned":1},{"functions":"support","new":0,"retained":9,"churned":0},{"functions":"data_science","new":0,"retained":4,"churned":0}]},{"start_date":"2023-06-01","departments":[{"functions":null,"new":17,"retained":98,"churned":0},{"functions":"accounting","new":0,"retained":1,"churned":0},{"functions":"sales","new":9,"retained":70,"churned":1},{"functions":"operations","new":1,"retained":21,"churned":0},{"functions":"finance","new":0,"retained":5,"churned":0},{"functions":"marketing","new":2,"retained":10,"churned":1},{"functions":"human_resources","new":3,"retained":21,"churned":0},{"functions":"information_technology","new":1,"retained":0,"churned":0},{"functions":"legal","new":0,"retained":1,"churned":0},{"functions":"engineering","new":16,"retained":100,"churned":0},{"functions":"business_development","new":1,"retained":14,"churned":0},{"functions":"product_management","new":0,"retained":13,"churned":0},{"functions":"consulting","new":1,"retained":2,"churned":0},{"functions":"education","new":0,"retained":4,"churned":0},{"functions":"media_and_commmunication","new":1,"retained":1,"churned":0},{"functions":"arts_and_design","new":1,"retained":7,"churned":0},{"functions":"support","new":0,"retained":7,"churned":2},{"functions":"data_science","new":1,"retained":4,"churned":0}]},{"start_date":"2023-07-01","departments":[{"functions":null,"new":9,"retained":114,"churned":2},{"functions":"accounting","new":0,"retained":1,"churned":0},{"functions":"sales","new":15,"retained":79,"churned":0},{"functions":"operations","new":1,"retained":23,"churned":0},{"functions":"finance","new":0,"retained":5,"churned":0},{"functions":"marketing","new":2,"retained":12,"churned":0},{"functions":"human_resources","new":1,"retained":24,"churned":0},{"functions":"information_technology","new":0,"retained":1,"churned":0},{"functions":"legal","new":0,"retained":1,"churned":0},{"functions":"engineering","new":9,"retained":116,"churned":0},{"functions":"business_development","new":1,"retained":15,"churned":0},{"functions":"product_management","new":2,"retained":12,"churned":1},{"functions":"consulting","new":2,"retained":3,"churned":0},{"functions":"education","new":1,"retained":4,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":2,"retained":8,"churned":0},{"functions":"support","new":1,"retained":7,"churned":0},{"functions":"data_science","new":0,"retained":5,"churned":0}]},{"start_date":"2023-08-01","departments":[{"functions":null,"new":6,"retained":119,"churned":1},{"functions":"accounting","new":0,"retained":1,"churned":0},{"functions":"sales","new":9,"retained":92,"churned":3},{"functions":"operations","new":0,"retained":24,"churned":0},{"functions":"finance","new":2,"retained":4,"churned":1},{"functions":"marketing","new":3,"retained":14,"churned":0},{"functions":"human_resources","new":0,"retained":26,"churned":0},{"functions":"information_technology","new":0,"retained":1,"churned":0},{"functions":"legal","new":2,"retained":1,"churned":0},{"functions":"engineering","new":10,"retained":124,"churned":1},{"functions":"business_development","new":0,"retained":17,"churned":0},{"functions":"product_management","new":0,"retained":14,"churned":0},{"functions":"consulting","new":0,"retained":4,"churned":1},{"functions":"education","new":0,"retained":5,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":10,"churned":0},{"functions":"support","new":0,"retained":12,"churned":0},{"functions":"data_science","new":1,"retained":5,"churned":0}]},{"start_date":"2023-09-01","departments":[{"functions":null,"new":6,"retained":123,"churned":1},{"functions":"accounting","new":1,"retained":1,"churned":0},{"functions":"sales","new":7,"retained":99,"churned":1},{"functions":"operations","new":0,"retained":22,"churned":0},{"functions":"finance","new":1,"retained":6,"churned":0},{"functions":"marketing","new":1,"retained":17,"churned":0},{"functions":"human_resources","new":1,"retained":26,"churned":0},{"functions":"information_technology","new":0,"retained":1,"churned":0},{"functions":"legal","new":0,"retained":3,"churned":0},{"functions":"engineering","new":9,"retained":134,"churned":0},{"functions":"business_development","new":1,"retained":17,"churned":0},{"functions":"product_management","new":1,"retained":13,"churned":1},{"functions":"consulting","new":0,"retained":4,"churned":0},{"functions":"education","new":1,"retained":6,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":2,"retained":10,"churned":0},{"functions":"support","new":0,"retained":12,"churned":0},{"functions":"data_science","new":0,"retained":6,"churned":0}]},{"start_date":"2023-10-01","departments":[{"functions":null,"new":5,"retained":129,"churned":0},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":7,"retained":104,"churned":2},{"functions":"operations","new":0,"retained":22,"churned":0},{"functions":"finance","new":0,"retained":7,"churned":0},{"functions":"marketing","new":1,"retained":18,"churned":0},{"functions":"human_resources","new":0,"retained":27,"churned":0},{"functions":"information_technology","new":1,"retained":1,"churned":0},{"functions":"legal","new":0,"retained":3,"churned":0},{"functions":"engineering","new":7,"retained":143,"churned":0},{"functions":"business_development","new":0,"retained":18,"churned":0},{"functions":"product_management","new":0,"retained":14,"churned":0},{"functions":"consulting","new":0,"retained":3,"churned":1},{"functions":"education","new":0,"retained":7,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":1,"churned":1},{"functions":"arts_and_design","new":1,"retained":12,"churned":0},{"functions":"support","new":0,"retained":12,"churned":0},{"functions":"data_science","new":0,"retained":6,"churned":0}]},{"start_date":"2023-11-01","departments":[{"functions":null,"new":3,"retained":135,"churned":0},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":3,"retained":110,"churned":0},{"functions":"operations","new":1,"retained":22,"churned":0},{"functions":"finance","new":0,"retained":7,"churned":0},{"functions":"marketing","new":0,"retained":19,"churned":0},{"functions":"human_resources","new":0,"retained":27,"churned":0},{"functions":"information_technology","new":1,"retained":2,"churned":0},{"functions":"legal","new":1,"retained":3,"churned":0},{"functions":"engineering","new":4,"retained":150,"churned":0},{"functions":"business_development","new":0,"retained":18,"churned":0},{"functions":"product_management","new":1,"retained":14,"churned":0},{"functions":"consulting","new":0,"retained":3,"churned":0},{"functions":"education","new":1,"retained":7,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":2,"retained":13,"churned":0},{"functions":"support","new":0,"retained":13,"churned":0},{"functions":"data_science","new":0,"retained":6,"churned":0}]},{"start_date":"2023-12-01","departments":[{"functions":null,"new":5,"retained":139,"churned":0},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":2,"retained":110,"churned":3},{"functions":"operations","new":1,"retained":23,"churned":0},{"functions":"finance","new":1,"retained":7,"churned":0},{"functions":"marketing","new":1,"retained":18,"churned":1},{"functions":"human_resources","new":0,"retained":27,"churned":0},{"functions":"information_technology","new":0,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":7,"retained":154,"churned":0},{"functions":"business_development","new":0,"retained":18,"churned":0},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":0,"retained":3,"churned":0},{"functions":"education","new":0,"retained":8,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":2,"retained":14,"churned":1},{"functions":"support","new":2,"retained":14,"churned":0},{"functions":"data_science","new":0,"retained":6,"churned":0}]},{"start_date":"2024-01-01","departments":[{"functions":null,"new":9,"retained":145,"churned":4},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":3,"retained":106,"churned":5},{"functions":"operations","new":0,"retained":23,"churned":0},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":2,"retained":18,"churned":1},{"functions":"human_resources","new":2,"retained":26,"churned":0},{"functions":"information_technology","new":0,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":8,"retained":159,"churned":2},{"functions":"business_development","new":0,"retained":18,"churned":0},{"functions":"product_management","new":2,"retained":13,"churned":2},{"functions":"consulting","new":1,"retained":2,"churned":0},{"functions":"education","new":1,"retained":7,"churned":1},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":1,"retained":14,"churned":2},{"functions":"support","new":0,"retained":17,"churned":0},{"functions":"data_science","new":1,"retained":7,"churned":0}]},{"start_date":"2024-02-01","departments":[{"functions":null,"new":8,"retained":154,"churned":0},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":0,"retained":105,"churned":3},{"functions":"operations","new":1,"retained":23,"churned":0},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":0,"retained":20,"churned":0},{"functions":"human_resources","new":0,"retained":28,"churned":0},{"functions":"information_technology","new":0,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":11,"retained":167,"churned":0},{"functions":"business_development","new":2,"retained":18,"churned":0},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":0,"retained":3,"churned":0},{"functions":"education","new":0,"retained":8,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":2,"retained":15,"churned":0},{"functions":"support","new":1,"retained":18,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":0}]},{"start_date":"2024-03-01","departments":[{"functions":null,"new":7,"retained":160,"churned":2},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":0,"retained":103,"churned":1},{"functions":"operations","new":1,"retained":24,"churned":0},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":0,"retained":21,"churned":0},{"functions":"human_resources","new":1,"retained":27,"churned":1},{"functions":"information_technology","new":0,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":9,"retained":178,"churned":0},{"functions":"business_development","new":0,"retained":20,"churned":0},{"functions":"product_management","new":1,"retained":14,"churned":1},{"functions":"consulting","new":1,"retained":3,"churned":0},{"functions":"education","new":0,"retained":7,"churned":1},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":17,"churned":0},{"functions":"support","new":1,"retained":19,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":0}]},{"start_date":"2024-04-01","departments":[{"functions":null,"new":5,"retained":162,"churned":5},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":1,"retained":101,"churned":2},{"functions":"operations","new":0,"retained":26,"churned":0},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":2,"retained":21,"churned":0},{"functions":"human_resources","new":0,"retained":28,"churned":0},{"functions":"information_technology","new":0,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":4,"retained":187,"churned":0},{"functions":"business_development","new":0,"retained":21,"churned":0},{"functions":"product_management","new":1,"retained":14,"churned":1},{"functions":"consulting","new":1,"retained":4,"churned":0},{"functions":"education","new":0,"retained":6,"churned":1},{"functions":"media_and_commmunication","new":2,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":17,"churned":0},{"functions":"support","new":0,"retained":20,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":0}]},{"start_date":"2024-05-01","departments":[{"functions":null,"new":8,"retained":165,"churned":2},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":3,"retained":97,"churned":2},{"functions":"operations","new":2,"retained":23,"churned":3},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":1,"retained":23,"churned":0},{"functions":"human_resources","new":0,"retained":26,"churned":2},{"functions":"information_technology","new":1,"retained":3,"churned":0},{"functions":"legal","new":0,"retained":4,"churned":0},{"functions":"engineering","new":4,"retained":188,"churned":3},{"functions":"business_development","new":0,"retained":18,"churned":3},{"functions":"product_management","new":0,"retained":14,"churned":1},{"functions":"consulting","new":0,"retained":5,"churned":0},{"functions":"education","new":0,"retained":7,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":4,"churned":0},{"functions":"arts_and_design","new":3,"retained":16,"churned":1},{"functions":"support","new":0,"retained":20,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":0}]},{"start_date":"2024-06-01","departments":[{"functions":null,"new":3,"retained":168,"churned":6},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":3,"retained":99,"churned":1},{"functions":"operations","new":2,"retained":23,"churned":1},{"functions":"finance","new":0,"retained":8,"churned":0},{"functions":"marketing","new":1,"retained":22,"churned":2},{"functions":"human_resources","new":0,"retained":22,"churned":3},{"functions":"information_technology","new":0,"retained":4,"churned":0},{"functions":"legal","new":1,"retained":4,"churned":0},{"functions":"engineering","new":2,"retained":189,"churned":4},{"functions":"business_development","new":0,"retained":17,"churned":0},{"functions":"product_management","new":1,"retained":12,"churned":2},{"functions":"consulting","new":1,"retained":5,"churned":0},{"functions":"education","new":0,"retained":7,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":4,"churned":0},{"functions":"arts_and_design","new":0,"retained":19,"churned":0},{"functions":"support","new":0,"retained":21,"churned":0},{"functions":"data_science","new":1,"retained":8,"churned":0}]},{"start_date":"2024-07-01","departments":[{"functions":null,"new":6,"retained":163,"churned":7},{"functions":"accounting","new":0,"retained":2,"churned":0},{"functions":"sales","new":3,"retained":101,"churned":1},{"functions":"operations","new":2,"retained":25,"churned":0},{"functions":"finance","new":0,"retained":6,"churned":2},{"functions":"marketing","new":3,"retained":23,"churned":0},{"functions":"human_resources","new":0,"retained":21,"churned":1},{"functions":"information_technology","new":0,"retained":4,"churned":0},{"functions":"legal","new":0,"retained":5,"churned":0},{"functions":"engineering","new":3,"retained":190,"churned":1},{"functions":"business_development","new":0,"retained":17,"churned":0},{"functions":"product_management","new":1,"retained":13,"churned":0},{"functions":"consulting","new":0,"retained":6,"churned":0},{"functions":"education","new":1,"retained":7,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":3,"churned":1},{"functions":"arts_and_design","new":1,"retained":19,"churned":0},{"functions":"support","new":0,"retained":22,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":1}]},{"start_date":"2024-08-01","departments":[{"functions":null,"new":1,"retained":169,"churned":1},{"functions":"accounting","new":1,"retained":2,"churned":0},{"functions":"sales","new":1,"retained":101,"churned":3},{"functions":"operations","new":0,"retained":26,"churned":1},{"functions":"finance","new":0,"retained":6,"churned":0},{"functions":"marketing","new":0,"retained":26,"churned":0},{"functions":"human_resources","new":0,"retained":20,"churned":1},{"functions":"information_technology","new":0,"retained":4,"churned":0},{"functions":"legal","new":0,"retained":5,"churned":0},{"functions":"engineering","new":4,"retained":192,"churned":1},{"functions":"business_development","new":0,"retained":16,"churned":1},{"functions":"product_management","new":2,"retained":13,"churned":1},{"functions":"consulting","new":1,"retained":6,"churned":0},{"functions":"education","new":1,"retained":8,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":1,"retained":20,"churned":0},{"functions":"support","new":0,"retained":22,"churned":0},{"functions":"data_science","new":0,"retained":8,"churned":0}]},{"start_date":"2024-09-01","departments":[{"functions":null,"new":5,"retained":169,"churned":1},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":2,"retained":99,"churned":3},{"functions":"operations","new":3,"retained":26,"churned":0},{"functions":"finance","new":0,"retained":5,"churned":1},{"functions":"marketing","new":1,"retained":24,"churned":2},{"functions":"human_resources","new":1,"retained":20,"churned":0},{"functions":"information_technology","new":1,"retained":4,"churned":0},{"functions":"legal","new":0,"retained":5,"churned":0},{"functions":"engineering","new":1,"retained":193,"churned":3},{"functions":"business_development","new":2,"retained":15,"churned":1},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":1,"retained":7,"churned":0},{"functions":"education","new":0,"retained":9,"churned":1},{"functions":"media_and_commmunication","new":1,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":20,"churned":1},{"functions":"support","new":1,"retained":22,"churned":0},{"functions":"data_science","new":1,"retained":8,"churned":0}]},{"start_date":"2024-10-01","departments":[{"functions":null,"new":7,"retained":168,"churned":4},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":0,"retained":101,"churned":3},{"functions":"operations","new":0,"retained":27,"churned":2},{"functions":"finance","new":0,"retained":5,"churned":0},{"functions":"marketing","new":1,"retained":22,"churned":3},{"functions":"human_resources","new":1,"retained":21,"churned":0},{"functions":"information_technology","new":0,"retained":5,"churned":0},{"functions":"legal","new":0,"retained":5,"churned":0},{"functions":"engineering","new":3,"retained":189,"churned":4},{"functions":"business_development","new":0,"retained":17,"churned":0},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":1,"retained":8,"churned":0},{"functions":"education","new":0,"retained":8,"churned":1},{"functions":"media_and_commmunication","new":0,"retained":3,"churned":0},{"functions":"arts_and_design","new":0,"retained":20,"churned":0},{"functions":"support","new":0,"retained":23,"churned":0},{"functions":"data_science","new":0,"retained":9,"churned":0}]},{"start_date":"2024-11-01","departments":[{"functions":null,"new":6,"retained":171,"churned":6},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":3,"retained":99,"churned":3},{"functions":"operations","new":1,"retained":25,"churned":2},{"functions":"finance","new":1,"retained":5,"churned":0},{"functions":"marketing","new":0,"retained":20,"churned":3},{"functions":"human_resources","new":1,"retained":21,"churned":1},{"functions":"information_technology","new":1,"retained":5,"churned":0},{"functions":"legal","new":1,"retained":5,"churned":0},{"functions":"engineering","new":2,"retained":190,"churned":2},{"functions":"business_development","new":1,"retained":16,"churned":1},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":0,"retained":9,"churned":0},{"functions":"education","new":0,"retained":8,"churned":0},{"functions":"administrative","new":1,"retained":0,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":1},{"functions":"arts_and_design","new":0,"retained":19,"churned":1},{"functions":"support","new":2,"retained":24,"churned":0},{"functions":"data_science","new":1,"retained":9,"churned":0}]},{"start_date":"2024-12-01","departments":[{"functions":null,"new":3,"retained":177,"churned":1},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":4,"retained":96,"churned":5},{"functions":"operations","new":3,"retained":26,"churned":0},{"functions":"finance","new":0,"retained":6,"churned":0},{"functions":"marketing","new":1,"retained":19,"churned":1},{"functions":"human_resources","new":0,"retained":22,"churned":0},{"functions":"information_technology","new":0,"retained":5,"churned":1},{"functions":"legal","new":0,"retained":5,"churned":1},{"functions":"engineering","new":5,"retained":191,"churned":1},{"functions":"business_development","new":0,"retained":16,"churned":1},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":0,"retained":8,"churned":1},{"functions":"education","new":0,"retained":8,"churned":0},{"functions":"administrative","new":0,"retained":1,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":19,"churned":0},{"functions":"support","new":0,"retained":25,"churned":1},{"functions":"data_science","new":0,"retained":10,"churned":0}]},{"start_date":"2025-01-01","departments":[{"functions":null,"new":8,"retained":178,"churned":2},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":1,"retained":98,"churned":2},{"functions":"operations","new":0,"retained":29,"churned":0},{"functions":"finance","new":1,"retained":4,"churned":2},{"functions":"marketing","new":1,"retained":20,"churned":0},{"functions":"human_resources","new":0,"retained":21,"churned":1},{"functions":"information_technology","new":0,"retained":5,"churned":0},{"functions":"legal","new":0,"retained":5,"churned":0},{"functions":"engineering","new":7,"retained":194,"churned":2},{"functions":"business_development","new":0,"retained":15,"churned":1},{"functions":"product_management","new":0,"retained":15,"churned":0},{"functions":"consulting","new":1,"retained":8,"churned":0},{"functions":"education","new":0,"retained":8,"churned":0},{"functions":"administrative","new":0,"retained":1,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":19,"churned":0},{"functions":"support","new":0,"retained":25,"churned":0},{"functions":"data_science","new":0,"retained":9,"churned":1}]},{"start_date":"2025-02-01","departments":[{"functions":null,"new":4,"retained":184,"churned":2},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":3,"retained":96,"churned":3},{"functions":"operations","new":0,"retained":27,"churned":2},{"functions":"finance","new":0,"retained":5,"churned":0},{"functions":"marketing","new":1,"retained":20,"churned":0},{"functions":"human_resources","new":0,"retained":21,"churned":0},{"functions":"information_technology","new":0,"retained":5,"churned":0},{"functions":"legal","new":1,"retained":5,"churned":0},{"functions":"engineering","new":2,"retained":201,"churned":0},{"functions":"business_development","new":0,"retained":15,"churned":0},{"functions":"product_management","new":1,"retained":15,"churned":0},{"functions":"consulting","new":0,"retained":9,"churned":0},{"functions":"education","new":1,"retained":8,"churned":0},{"functions":"administrative","new":0,"retained":1,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":0,"retained":19,"churned":0},{"functions":"support","new":0,"retained":23,"churned":2},{"functions":"data_science","new":1,"retained":9,"churned":0}]},{"start_date":"2025-03-01","departments":[{"functions":null,"new":6,"retained":187,"churned":0},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":5,"retained":96,"churned":3},{"functions":"operations","new":0,"retained":27,"churned":0},{"functions":"finance","new":1,"retained":5,"churned":0},{"functions":"marketing","new":2,"retained":20,"churned":2},{"functions":"human_resources","new":1,"retained":20,"churned":0},{"functions":"information_technology","new":0,"retained":5,"churned":0},{"functions":"legal","new":0,"retained":6,"churned":0},{"functions":"engineering","new":0,"retained":203,"churned":0},{"functions":"business_development","new":0,"retained":14,"churned":1},{"functions":"product_management","new":0,"retained":16,"churned":0},{"functions":"consulting","new":0,"retained":9,"churned":1},{"functions":"education","new":1,"retained":9,"churned":0},{"functions":"administrative","new":0,"retained":1,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":2,"churned":0},{"functions":"arts_and_design","new":1,"retained":19,"churned":0},{"functions":"support","new":0,"retained":23,"churned":0},{"functions":"data_science","new":0,"retained":10,"churned":0}]},{"start_date":"2025-04-01","departments":[{"functions":null,"new":5,"retained":189,"churned":3},{"functions":"accounting","new":0,"retained":3,"churned":0},{"functions":"sales","new":2,"retained":99,"churned":2},{"functions":"operations","new":0,"retained":26,"churned":1},{"functions":"finance","new":1,"retained":6,"churned":0},{"functions":"marketing","new":0,"retained":20,"churned":2},{"functions":"human_resources","new":2,"retained":21,"churned":0},{"functions":"information_technology","new":0,"retained":5,"churned":0},{"functions":"legal","new":1,"retained":5,"churned":1},{"functions":"engineering","new":3,"retained":204,"churned":0},{"functions":"business_development","new":2,"retained":14,"churned":0},{"functions":"product_management","new":1,"retained":16,"churned":0},{"functions":"consulting","new":0,"retained":7,"churned":2},{"functions":"education","new":0,"retained":10,"churned":0},{"functions":"administrative","new":0,"retained":1,"churned":0},{"functions":"media_and_commmunication","new":0,"retained":1,"churned":1},{"functions":"arts_and_design","new":1,"retained":20,"churned":0},{"functions":"support","new":2,"retained":23,"churned":1},{"functions":"data_science","new":0,"retained":9,"churned":1}]}],"has_intent_signal_account":true,"intent_signal_account":{"_id":"6663bd946cef250001def02a","account_id":"6658955677a2f20001c647ad","aggregated_at":"2024-09-04T10:02:28.878+00:00","computed":true,"created_at":"2024-06-08T02:10:28.537Z","domain_aggregates":[{"domain":"tableofdiscontents.com","total_visits":15,"last_visit":20240611,"first_visit":20240607,"unique_visitors":6,"weekly_aggregates":[{"week_start_date":"2024-06-07T00:00:00.000Z","count":15}],"top_5_paths":[{"_id":"www.tableofdiscontents.com","total_visits":9},{"_id":"www.tableofdiscontents.com/pricing","total_visits":3},{"_id":"www.tableofdiscontents.com/premium","total_visits":2},{"_id":"www.tableofdiscontents.com/features","total_visits":1}],"intent":"low","intent_score":0}],"first_visited_at":20240607,"last_visited_at":20240611,"need_aggregation":false,"need_es_update":false,"new_reveal":false,"organization_id":"5e66b6381e05b4008c8331b8","overall_intent":"low","pre_generated_account_id":"6658955677a2f20001c647ad","random":0.162172829,"team_id":"6095a710bd01d100a506d4ac","team_org_id":"6095a710bd01d100a506d4ac_5e66b6381e05b4008c8331b8","total_visits":15,"unique_visitors":6,"updated_at":"2024-09-04T10:02:28.959Z","website_visitor_metrics":{"overall_intent":"low","total_visits":15,"unique_visitors":6,"domain_aggregates":[{"domain":"tableofdiscontents.com","first_intent_signal_received_at":20240607,"last_intent_signal_received_at":20240611}],"page_view_aggregates":{"one_day_count":0,"seven_day_count":0,"fifteen_day_count":0,"thirty_day_count":0,"sixty_day_count":0,"ninety_day_count":15},"pages":["www.tableofdiscontents.com","www.tableofdiscontents.com/pricing","www.tableofdiscontents.com/premium","www.tableofdiscontents.com/features"],"first_intent_signal_received_at":20240607,"last_intent_signal_received_at":20240611},"id":"6663bd946cef250001def02a","key":"6663bd946cef250001def02a"},"generic_org_insights":null,"show_intent":false,"detail_view_loaded":true}},"summary":"OK"}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/accounts/show is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"Parameters misconfigured. id is not a valid ID","summary":"Check Organization ID"}}}}}},"parameters":[{"name":"id","in":"path","required":true,"description":"The Apollo ID for the organization that you want to research.

To find organization IDs, call the Organization Search endpoint and identify the `organizaton_id` value for the organization.

Example: `5e66b6381e05b4008c8331b8`","schema":{"type":"string","default":""}}]}},"/people/{id}":{"get":{"summary":"Get Complete Person Info","description":"This endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Get Complete Person Info endpoint to retrieve complete details about a person in the Apollo database, including employment history, location, and the full details of the person's current organization.

This endpoint requires a master API key. If you call this endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Search"],"operationId":"get_people{id}","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"value":{"person":{"id":"65f0a1b2c3d4e5f600012345","first_name":"Ava","last_name":"Ruiz","name":"Ava Ruiz","linkedin_url":"http://www.linkedin.com/in/ava-ruiz-123456","title":"Founder & CEO","photo_url":"https://media.sumware.com/photos/ava-ruiz.jpg","twitter_url":null,"github_url":null,"facebook_url":null,"extrapolated_email_confidence":null,"headline":"Founder & CEO at Sumware Software","organization_id":"5f1a2b3c4d5e6f0001234567","employment_history":[{"_id":"65f0a1b2c3d4e5f600012346","created_at":null,"current":true,"degree":null,"description":null,"emails":null,"end_date":null,"grade_level":null,"kind":null,"major":null,"organization_id":"5f1a2b3c4d5e6f0001234567","organization_name":"Sumware Software","raw_address":null,"start_date":"2015-01-01","title":"Founder & CEO","updated_at":null,"id":"65f0a1b2c3d4e5f600012346","key":"65f0a1b2c3d4e5f600012346"}],"street_address":"172 Bryant Street","city":"San Francisco","state":"California","country":"United States","postal_code":"94105","formatted_address":"172 Bryant Street, San Francisco, California, United States, 94105","time_zone":"America/Los_Angeles","email":"ava.ruiz@sumware.com","email_status":"verified"}},"summary":"OK"}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/people/show is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"Person Does Not Exist":{"value":"{\n \"error\": \"Person does not exist.\"\n}","summary":"Check Person ID"},"Obsolete Data":{"value":"{\n \"error\": \"This is obsolete data.\"\n}","summary":"Person record is no longer available"}}}}}},"parameters":[{"name":"id","in":"path","required":true,"description":"The Apollo ID for the person that you want to research.

To find person IDs, call the People Search endpoint and identify the `id` value for the person.

Example: `65f0a1b2c3d4e5f600012345`","schema":{"type":"string","default":""}}]}},"/accounts/{id}":{"get":{"summary":"View an Account","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nAn account is a company saved in Apollo.

Use the View an Account endpoint to retrieve details for an existing account.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create API keys to learn how to create a master key.","tags":["Accounts"],"operationId":"get_accounts{id}","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"account":{"id":"6518c6184f20350001a0b9c0","name":"Apollo.io","website_url":"http://www.apollo.io","linkedin_url":"http://www.linkedin.com/company/apolloio","twitter_url":"https://twitter.com/MeetApollo/","facebook_url":"https://facebook.com/MeetApollo/","alexa_ranking":3514,"linkedin_uid":"18511550","founded_year":2015,"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/b1bdd6009b1611149b56f0bc/picture","primary_domain":"apollo.io","industry":"information technology & services","estimated_num_employees":910,"keywords":["sales engagement","lead generation","predictive analytics","lead scoring","sales strategy","conversation intelligence","sales enablement","lead routing","sales development","email engagement","revenue intelligence","sales operations","sales intelligence","lead intelligence","prospecting","b2b data","software development","crm integration","data enrichment","deal management","pipeline management","automated workflows","analytics & reporting","coaching & feedback","signal-based prospecting","inbound optimization","contact & account search","email outreach automation","meeting scheduling","ai sales assistant","multi-channel outreach","lead qualification","form optimization","sales performance improvement","live data network","ai sales automation","revops tools","account-based prospecting","sales pipeline","meeting preparedness","ai recommendations","webinar integration","sales coaching","team collaboration","sales insights","buyer's journey tracking","market intelligence","lead prioritization","customer journey mapping","sales funnel tracking","data-driven sales","email deliverability management","automated lead follow-up","predictive analytics for sales","sales campaign management","sales productivity tools","sales performance management","b2b sales intelligence","ai-driven automation","prospecting tools","contact database","sales automation","email tracking","intent data","sales workflow management","advanced search filters","customer success","scalable solutions","sales analytics","outreach optimization","data-driven strategies","customer acquisition","sales productivity","marketing automation","user-friendly interface","comprehensive features","business growth","sales optimization","competitive advantage","market potential","sales teams","enterprise solutions","small business support","mid-market focus","diverse industries","customer demographics","sales intelligence platform","marketing & advertising","sales","information technology & services","enterprise software","enterprises","computer software","b2b","saas"],"industries":["information technology & services"],"secondary_industries":[],"snippets_loaded":true,"industry_tag_id":"5567cd4773696439b10b0000","industry_tag_hash":{"information technology & services":"5567cd4773696439b10b0000"},"retail_location_count":0,"raw_address":"535 mission st, san francisco, california, united states, 94105","street_address":"535 Mission Street","city":"San Francisco","state":"California","country":"United States","postal_code":"94105","owned_by_organization_id":null,"short_description":"Apollo.io is an AI sales platform that provides businesses with tools to enhance their go-to-market strategies. Founded in 2015 by Tim and Ray, the company was created to address the limitations of existing sales tools they encountered in their previous startup. Apollo.io offers an all-in-one platform that integrates lead intelligence and sales engagement capabilities, helping businesses find leads, engage prospects, and close deals more effectively.\n\nThe platform features detailed insights into potential customers, tools for managing leads from initial contact to deal closure, and a community-based approach to data accuracy. Apollo.io serves nearly 9,000 paying customers, including startups and large enterprises, and supports over 500,000 sales professionals globally. The company has experienced rapid growth, surpassing $100 million in annual recurring revenue and achieving a valuation of $1.6 billion. Apollo.io has also received funding from notable investors like Y Combinator and Nexus Venture Partners.","suborganizations":[],"num_suborganizations":0,"annual_revenue_printed":"100M","annual_revenue":100000000,"total_funding":251200000,"total_funding_printed":"251.2M","latest_funding_round_date":"2023-08-01T00:00:00.000+00:00","latest_funding_stage":"Series D","funding_events":[{"id":"6574c1ff9b797d0001fdab1b","date":"2023-08-01T00:00:00.000+00:00","news_url":null,"type":"Series D","investors":"Bain Capital Ventures, Sequoia Capital, Tribe Capital, Nexus Venture Partners","amount":"100M","currency":"$"},{"id":"624f4dfec786590001768016","date":"2022-03-01T00:00:00.000+00:00","news_url":null,"type":"Series C","investors":"Sequoia Capital, Tribe Capital, Nexus Venture Partners, NewView Capital","amount":"110M","currency":"$"},{"id":"61b13677623110000186a478","date":"2021-10-01T00:00:00.000+00:00","news_url":null,"type":"Series B","investors":"Tribe Capital, NewView Capital, Nexus Venture Partners","amount":"32M","currency":"$"},{"id":"5ffe93caa54d75077c59acef","date":"2018-06-26T00:00:00.000+00:00","news_url":"https://techcrunch.com/2018/06/26/yc-grad-zenprospect-rebrands-as-apollo-lands-7-m-series-a/","type":"Series A","investors":"Nexus Venture Partners, Social Capital, Y Combinator","amount":"7M","currency":"$"},{"id":"6574c1ff9b797d0001fdab20","date":"2016-10-01T00:00:00.000+00:00","news_url":null,"type":"Other","investors":"Y Combinator, SV Angel, Social Capital, Nexus Venture Partners","amount":"2.2M","currency":"$"}],"technology_names":["AI","Android","Basis","Canva","Circle","CloudFlare Hosting","Cloudflare DNS","Drift","Gmail","Google Apps","Google Tag Manager","Google Workspace","Hubspot","Microsoft Office 365","Mobile Friendly","Python","Rackspace MailGun","Remote","Render","Reviews","Salesforce","SharePoint","Stripe","WP Engine","Webmail","Zendesk"],"current_technologies":[{"uid":"ai","name":"AI","category":"Other"},{"uid":"android","name":"Android","category":"Frameworks and Programming Languages"},{"uid":"basis","name":"Basis","category":"Advertising Networks"},{"uid":"canva","name":"Canva","category":"Content Management Platform"},{"uid":"circle","name":"Circle","category":"Financial Software"},{"uid":"cloudflare_hosting","name":"CloudFlare Hosting","category":"Hosting"},{"uid":"cloudflare_dns","name":"Cloudflare DNS","category":"Domain Name Services"},{"uid":"drift","name":"Drift","category":"Widgets"},{"uid":"gmail","name":"Gmail","category":"Email Providers"},{"uid":"google_apps","name":"Google Apps","category":"Other"},{"uid":"google_tag_manager","name":"Google Tag Manager","category":"Tag Management"},{"uid":"google workspace","name":"Google Workspace","category":"Cloud Services"},{"uid":"hubspot","name":"Hubspot","category":"Marketing Automation"},{"uid":"office_365","name":"Microsoft Office 365","category":"Other"},{"uid":"mobile_friendly","name":"Mobile Friendly","category":"Other"},{"uid":"python","name":"Python","category":"Frameworks and Programming Languages"},{"uid":"rackspace_mailgun","name":"Rackspace MailGun","category":"Email Delivery"},{"uid":"remote","name":"Remote","category":"Other"},{"uid":"render","name":"Render","category":"Other"},{"uid":"reviews","name":"Reviews","category":"Customer Reviews"},{"uid":"salesforce","name":"Salesforce","category":"Customer Relationship Management"},{"uid":"sharepoint","name":"SharePoint","category":"CMS"},{"uid":"stripe","name":"Stripe","category":"Payments"},{"uid":"wp_engine","name":"WP Engine","category":"CMS"},{"uid":"webmail","name":"Webmail","category":"Email Providers"},{"uid":"zendesk","name":"Zendesk","category":"Support and Feedback"}],"org_chart_root_people_ids":["66f6de0d74c57a00015d2b39"],"org_chart_sector":"OrgChart::SectorHierarchy::Rules::IT","org_chart_removed":false,"org_chart_show_department_filter":true,"organization_raw_address":"535 mission street, san francisco, california, united states, 94105","organization_postal_code":"94105","organization_street_address":"535 Mission Street","organization_city":"San Francisco","organization_state":"California","organization_country":"United States","suggest_location_enrichment":false,"domain":"apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":"6095a710bd01d100a506d4b9","source":"job_change","original_source":"job_change","creator_id":"60affe7d6e270a00f5db6fe4","owner_id":"66302798d03b9601c7934ec2","created_at":"2023-10-01T01:06:32.057Z","phone":"+1 415-555-0181","phone_status":"no_status","salesforce_id":"0017ntaJPTvuIbOUVM","crm_owner_id":"005dK4PthD6owdyIkD","engagement_graph":[{"year":2024,"month":7,"inbound":0,"outbound":2},{"year":2025,"month":1,"inbound":0,"outbound":2},{"year":2025,"month":2,"inbound":0,"outbound":1},{"year":2025,"month":3,"inbound":0,"outbound":4},{"year":2025,"month":4,"inbound":0,"outbound":3}],"sanitized_phone":"+14155550181","account_playbook_statuses":[],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{"671932d76c03c402d0528199":["671932d76c03c402d0528195"]},"custom_field_errors":{},"modality":"account","source_display_name":"Job Change","salesforce_record_url":"https://orgfarm-1a2b3c4d5e-dev-ed.develop.my.salesforce.com/0017ntaJPTvuIbOUVM","crm_record_url":null,"contact_emailer_campaign_ids":["61964b4f2f2b4801128bdccf","617006aa01d9c3008c563b80","6137561c78029300a4442f2c","61df24be4ed86000a4f05dab","624dbc81790dd000a518a8f7","626975c09d940c00a5e0685d","624b4d82f6a95501165cafcc","626a709fa58d1c008d9a9deb","626a8ed480fa5f00ddebaae3","657c8b7bc0ee7301c689fbbe","65820320ea75fb06b0921560","66425e61b56bc503009c8c15","66a97236a8759801b5417678","66e9e215ece19801b219997f","6462b4b66ec01300a3388865","665755d24404d001d65dd7ea","672131a9213b0403ebbfcf20","6480faa352529300f1501086","66186b69391e0901c7dc89b0","6789e720c2277502d07c33ee","681a8f70182476001d4115f1","67bde6d5b5eeec0021ad09c2","67be333b81ca47000d1cfb9f","680011ea812b54001dcd28c6","60c0ec0be9da2200a425bfd1","65ea4082b0815b01ae2f248b","662a75fe1d925201c7a8c26d","6567758e12b81a0264ab0bb1"],"contact_campaign_status_tally":{"active":29,"finished":27,"not_sent":25,"paused":10,"bounced":1},"num_contacts":100,"last_activity_date":"2025-04-25T18:46:35.000+00:00","intent_strength":null,"show_intent":false,"intent_signal_account":null,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null,"account_queues":[],"disable_flag":false},"salesforce_users":[],"hubspot_owners":[]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/accounts/show is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"Check Account ID":{"value":{"error":"Parameters misconfigured. id is not a valid ID"},"summary":"Check Account ID"}}}}}},"parameters":[{"name":"id","in":"path","required":true,"description":"The Apollo ID for the account that you want to retrieve.

To find account IDs, call the Search for Accounts endpoint and identify the `id` value for the account.

Example: `6518c6184f20350001a0b9c0`","schema":{"type":"string","default":""}}]}},"/phone_calls/search":{"get":{"summary":"Search for Calls","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Search for Calls endpoint to find calls that your team has made or received using the dialer on Apollo.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master API key.","tags":["Calls"],"operationId":"get_phone_callssearch","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"value":"{\n \"pagination\": {\n \"page\": \"1\",\n \"per_page\": \"5\",\n \"total_entries\": 17,\n \"total_pages\": 4\n },\n \"breadcrumbs\": [\n {\n \"label\": \"Date\",\n \"signal_field_name\": \"date_range\",\n \"value\": \"2025-04-01\",\n \"display_name\": \"After Tue, Apr 01\"\n },\n {\n \"label\": \"Date\",\n \"signal_field_name\": \"date_range\",\n \"value\": \"2025-06-12\",\n \"display_name\": \"Before Today\"\n }\n ],\n \"phone_calls\": [\n {\n \"id\": \"684b5631a57ddb0021985250\",\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"contact_id\": \"657a43dd324b9902d0c4dd37\",\n \"voice_setting_id\": \"684b5618cea999001da519c6\",\n \"phone_call_outcome_id\": null,\n \"phone_call_purpose_id\": null,\n \"recording_url\": null,\n \"twilio_call_sid\": \"CA218198b1015dd6db8d790275bfd4550e\",\n \"call_identifier\": \"ad2c1a48-23fc-4a2d-96a9-c0ad8a95c01d\",\n \"agent_call_sid\": null,\n \"inbound\": false,\n \"from_number\": \"+15735550189\",\n \"to_number\": \"+14155550181\",\n \"start_time\": \"2025-06-12T22:35:29.000+00:00\",\n \"end_time\": \"2025-06-12T22:35:35.000+00:00\",\n \"transcription_too_long\": null,\n \"twilio_recording_sid\": null,\n \"need_recording_upload\": true,\n \"logged\": false,\n \"note\": null,\n \"status\": \"no-answer\",\n \"outreach_task_id\": null,\n \"salesforce_id\": null,\n \"hubspot_id\": null,\n \"conference_id\": null,\n \"opportunity_id\": null,\n \"voicemail_dropped\": false,\n \"parallel_dial_item_id\": null,\n \"transcribed\": false,\n \"transcribing\": false,\n \"transcription_progress\": 0,\n \"note_text\": \"\",\n \"contact\": {\n \"organization_logo_url\": \"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/b1bdd6009b1611149b56f0bc/picture\",\n \"contact_roles\": [],\n \"id\": \"657a43dd324b9902d0c4dd37\",\n \"first_name\": \"Marcus\",\n \"last_name\": \"Hale\",\n \"name\": \"Marcus Hale\",\n \"linkedin_url\": null,\n \"title\": null,\n \"contact_stage_id\": \"6095a710bd01d100a506d4af\",\n \"owner_id\": \"66302798d03b9601c7934ec2\",\n \"creator_id\": \"60affe7d6e270a00f5db6fe4\",\n \"person_id\": null,\n \"email_needs_tickling\": null,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"meetings_scheduled_in_app\",\n \"original_source\": \"meetings_scheduled_in_app\",\n \"organization_id\": \"5e66b6381e05b4008c8331b8\",\n \"headline\": null,\n \"photo_url\": null,\n \"present_raw_address\": null,\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": \"003TE0k3i0Ln1ORd2n\",\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": \"003TE0k3i0Ln1ORd2n\",\n \"salesforce_account_id\": \"0017ntaJPTvuIbOUVM\",\n \"crm_owner_id\": \"005dK4PthD6owdyIkD\",\n \"created_at\": \"2023-12-13T23:53:01.613Z\",\n \"emailer_campaign_ids\": [],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"city\": null,\n \"country\": null,\n \"state\": null,\n \"email_status\": \"verified\",\n \"email_source\": null,\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"last_activity_date\": \"2025-03-14T16:23:29.000+00:00\",\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": \"003TE0k3i0Ln1ORd2n\",\n \"sanitized_phone\": \"+14155550181\",\n \"merged_crm_ids\": null,\n \"updated_at\": \"2025-06-12T20:48:47.840Z\",\n \"queued_for_crm_push\": false,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"person_deleted\": null,\n \"call_opted_out\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"marcus.hale@apollo.io\",\n \"email_from_customer\": true,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": null,\n \"salesforce_record_url\": \"https://orgfarm-1a2b3c4d5e-dev-ed.develop.my.salesforce.com/003TE0k3i0Ln1ORd2n\",\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"User Managed\",\n \"updated_email_true_status\": true,\n \"source_display_name\": \"Added from Meetings Scheduling\",\n \"twitter_url\": null,\n \"facebook_url\": null,\n \"contact_emails\": [\n {\n \"email_md5\": \"ae850a27907a25093bbc837c210ae5a3\",\n \"email_sha256\": \"125671f13e9632a503bb5aa9b928c8105c044901c4f13a21818f9da209fc87a4\",\n \"email_status\": \"verified\",\n \"extrapolated_email_confidence\": null,\n \"position\": 0,\n \"email\": \"marcus.hale@apollo.io\",\n \"free_domain\": false,\n \"source\": \"User Managed\",\n \"third_party_vendor_name\": null,\n \"vendor_validation_statuses\": [],\n \"email_needs_tickling\": null,\n \"email_true_status\": \"User Managed\",\n \"email_status_unavailable_reason\": null\n }\n ],\n \"intent_strength\": null,\n \"show_intent\": false,\n \"phone_numbers\": [\n {\n \"raw_number\": \"+1 415-555-0181\",\n \"sanitized_number\": \"+14155550181\",\n \"type\": \"work_hq\",\n \"position\": 0,\n \"status\": \"no_status\",\n \"dnc_status\": null,\n \"dnc_other_info\": {},\n \"dialer_flags\": null,\n \"source_name\": \"Apollo\",\n \"vendor_validation_statuses\": [],\n \"third_party_vendor_name\": null\n }\n ],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"email_domain_catchall\": false\n },\n \"duration\": 0,\n \"conversation_id\": null\n },\n {\n \"id\": \"683dd5ebeff21a000d3b59b1\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"account_id\": null,\n \"contact_id\": null,\n \"voice_setting_id\": \"66423383e444d7043a550a93\",\n \"phone_call_outcome_id\": null,\n \"phone_call_purpose_id\": null,\n \"recording_url\": \"https://api.twilio.com/2010-04-01/Accounts/AC387e8a4c479a1cfacf2307a6ac8ed4c4/Recordings/RE7f322dec3b25154e4a05751f802a3a85\",\n \"twilio_call_sid\": \"CAe13f2421ccd41b3593ca65eaf5d930f8\",\n \"call_identifier\": null,\n \"agent_call_sid\": \"CAc1f591997d5dba2b1c26e9d6dfd3d614\",\n \"inbound\": true,\n \"from_number\": \"+19515550199\",\n \"to_number\": \"+15625550183\",\n \"start_time\": \"2025-06-02T16:48:43.000+00:00\",\n \"end_time\": \"2025-06-02T16:48:46.000+00:00\",\n \"transcription_too_long\": null,\n \"twilio_recording_sid\": \"RE7f322dec3b25154e4a05751f802a3a85\",\n \"need_recording_upload\": true,\n \"logged\": false,\n \"note\": null,\n \"status\": \"completed\",\n \"outreach_task_id\": null,\n \"salesforce_id\": null,\n \"hubspot_id\": null,\n \"conference_id\": null,\n \"opportunity_id\": null,\n \"voicemail_dropped\": false,\n \"parallel_dial_item_id\": null,\n \"transcribed\": false,\n \"transcribing\": false,\n \"transcription_progress\": 0,\n \"note_text\": \"\",\n \"duration\": 3,\n \"conversation_id\": null\n },\n {\n \"id\": \"6839d628897392000d8c3e75\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"account_id\": null,\n \"contact_id\": null,\n \"voice_setting_id\": \"66423383e444d7043a550a93\",\n \"phone_call_outcome_id\": null,\n \"phone_call_purpose_id\": null,\n \"recording_url\": \"https://api.twilio.com/2010-04-01/Accounts/AC387e8a4c479a1cfacf2307a6ac8ed4c4/Recordings/REca35d88c03f7d3dfa111701454a4f0cc\",\n \"twilio_call_sid\": \"CA1e9460d41ae47a0174b5b2e7c85f1656\",\n \"call_identifier\": null,\n \"agent_call_sid\": \"CA3b3d89be17ba26ae5f706a4c5b9ac799\",\n \"inbound\": true,\n \"from_number\": \"+19515550199\",\n \"to_number\": \"+15625550183\",\n \"start_time\": \"2025-05-30T16:00:40.000+00:00\",\n \"end_time\": \"2025-05-30T16:00:44.000+00:00\",\n \"transcription_too_long\": null,\n \"twilio_recording_sid\": \"REca35d88c03f7d3dfa111701454a4f0cc\",\n \"need_recording_upload\": true,\n \"logged\": false,\n \"note\": null,\n \"status\": \"completed\",\n \"outreach_task_id\": null,\n \"salesforce_id\": null,\n \"hubspot_id\": null,\n \"conference_id\": null,\n \"opportunity_id\": null,\n \"voicemail_dropped\": false,\n \"parallel_dial_item_id\": null,\n \"transcribed\": false,\n \"transcribing\": false,\n \"transcription_progress\": 0,\n \"note_text\": \"\",\n \"duration\": 4,\n \"conversation_id\": null\n },\n {\n \"id\": \"683760e6aac06700213aa9d5\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"account_id\": null,\n \"contact_id\": null,\n \"voice_setting_id\": \"66423383e444d7043a550a93\",\n \"phone_call_outcome_id\": null,\n \"phone_call_purpose_id\": null,\n \"recording_url\": \"https://api.twilio.com/2010-04-01/Accounts/AC387e8a4c479a1cfacf2307a6ac8ed4c4/Recordings/RE25b1312a9ccf9836c8936f16707ee88c\",\n \"twilio_call_sid\": \"CA6a3674fe3760608ef64c0601f0410487\",\n \"call_identifier\": null,\n \"agent_call_sid\": \"CAcd8eb6f71a1ee1092197626db6d8bd68\",\n \"inbound\": true,\n \"from_number\": \"+19515550199\",\n \"to_number\": \"+15625550183\",\n \"start_time\": \"2025-05-28T19:15:50.000+00:00\",\n \"end_time\": \"2025-05-28T19:16:10.000+00:00\",\n \"transcription_too_long\": null,\n \"twilio_recording_sid\": \"RE25b1312a9ccf9836c8936f16707ee88c\",\n \"need_recording_upload\": true,\n \"logged\": false,\n \"note\": null,\n \"status\": \"completed\",\n \"outreach_task_id\": null,\n \"salesforce_id\": null,\n \"hubspot_id\": null,\n \"conference_id\": null,\n \"opportunity_id\": null,\n \"voicemail_dropped\": false,\n \"parallel_dial_item_id\": null,\n \"transcribed\": false,\n \"transcribing\": false,\n \"transcription_progress\": 0,\n \"note_text\": \"\",\n \"duration\": 20,\n \"conversation_id\": null\n },\n {\n \"id\": \"68373d81b6ef6b001dc9b7aa\",\n \"user_id\": \"66302798d03b9601c7934ebc\",\n \"account_id\": null,\n \"contact_id\": null,\n \"voice_setting_id\": \"66423383e444d7043a550a93\",\n \"phone_call_outcome_id\": null,\n \"phone_call_purpose_id\": null,\n \"recording_url\": \"https://api.twilio.com/2010-04-01/Accounts/AC387e8a4c479a1cfacf2307a6ac8ed4c4/Recordings/RE8a53d661e9eae6724d41923212c3ad9a\",\n \"twilio_call_sid\": \"CA07d7bf8c756999217998e8bae0f18479\",\n \"call_identifier\": null,\n \"agent_call_sid\": \"CA667d80530c73a64fc09ec76b040063df\",\n \"inbound\": true,\n \"from_number\": \"+19515550199\",\n \"to_number\": \"+15625550183\",\n \"start_time\": \"2025-05-28T16:44:49.000+00:00\",\n \"end_time\": \"2025-05-28T16:45:10.000+00:00\",\n \"transcription_too_long\": null,\n \"twilio_recording_sid\": \"RE8a53d661e9eae6724d41923212c3ad9a\",\n \"need_recording_upload\": true,\n \"logged\": false,\n \"note\": null,\n \"status\": \"completed\",\n \"outreach_task_id\": null,\n \"salesforce_id\": null,\n \"hubspot_id\": null,\n \"conference_id\": null,\n \"opportunity_id\": null,\n \"voicemail_dropped\": false,\n \"parallel_dial_item_id\": null,\n \"transcribed\": false,\n \"transcribing\": false,\n \"transcription_progress\": 0,\n \"note_text\": \"\",\n \"duration\": 21,\n \"conversation_id\": null\n }\n ],\n \"faceting\": {\n \"phone_call_stats_facets\": [\n {\n \"value\": \"active\",\n \"display_name\": \"Active Calls\",\n \"count\": 0\n },\n {\n \"value\": \"6095a710bd01d100a506d4c5\",\n \"display_name\": \"Left Voicemail\",\n \"count\": 1\n },\n {\n \"value\": \"other\",\n \"display_name\": \"No Disposition\",\n \"count\": 15\n },\n {\n \"value\": \"6095a710bd01d100a506d4ca\",\n \"display_name\": \"Connected - Positive\",\n \"count\": 1\n }\n ]\n },\n \"pipeline_total\": 17,\n \"num_fetch_result\": null\n}","summary":"OK"}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/phone_calls/search is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}}},"parameters":[{"name":"date_range[max]","in":"query","required":false,"description":"Set the upper bound of the date range you want to search.

Use this parameter in combination with the `date_range[min]` parameter. This date should fall after the `date_range[min]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-06-12`","schema":{"type":"string","format":"date","default":""}},{"name":"date_range[min]","in":"query","required":false,"description":"Set the lower bound of the date range you want to search.

Use this parameter in combination with the `date_range[max]` parameter. This date should fall before the `date_range[max]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-04-01`","schema":{"type":"string","format":"date","default":""}},{"name":"duration[max]","in":"query","required":false,"description":"Set the upper bound for the call duration you want to search. The duration should be seconds, not minutes or hours.

Use this parameter in combination with the `duration[min]` parameter. This number should be larger than `duration[min]`.

Example: `180`","schema":{"type":"integer","default":""}},{"name":"duration[min]","in":"query","required":false,"description":"Set the lower bound for the call duration you want to search. The duration should be seconds, not minutes or hours.

Use this parameter in combination with the `duration[max]` parameter. This number should be smallerr than `duration[min]`.

Example: `30`","schema":{"type":"integer","default":""}},{"name":"inbound","in":"query","required":false,"description":"Search for calls based on whether they were `incoming` (the prospect called your team) or `outgoing` (your team called the prospect).","schema":{"type":"string","default":""}},{"name":"user_ids[]","in":"query","required":false,"description":"Find calls that included specific users in your team's Apollo account. You can add multiple users.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `67e33d527de088000daa60c4`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"contact_label_ids[]","in":"query","required":false,"description":"Find calls that included specific contacts. You can add multiple contacts.

In Apollo terminology, a contact is a person that your team has explicitly added to your database.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `67e33d527de088000daa60c4` 6708415f59d9c70001b2f852","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"phone_call_purpose_ids[]","in":"query","required":false,"description":"Filter calls based on their purpose.

Call purposes are unique to your team's Apollo account. When you use the Purpose search filter for calls in the Apollo product, you can find the corresponding call purpose ID in the URL.

Example: `6095a710bd01d100a506d4cf`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"phone_call_outcome_ids[]","in":"query","required":false,"description":"Filter calls based on their outcome.

Call outcomes are unique to your team's Apollo account. When you use the Disposition search filter for calls in the Apollo product, you can find the corresponding call outcome ID in the URL.

Example: `6095a710bd01d100a506d4c5`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"q_keywords","in":"query","required":false,"description":"Add keywords to narrow the search of the calls in your team's Apollo account.

Example: `marketing conference attendees`","schema":{"type":"string","default":""}},{"name":"page","in":"query","required":false,"description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`","schema":{"type":"string","default":""}},{"name":"per_page","in":"query","required":false,"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.

Use the page parameter to search the different pages of data.

Example: `10`","schema":{"type":"string","default":""}}]}},"/emailer_messages/{id}/activities":{"get":{"summary":"Check Email Stats","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Check Email Stats endpoint to review the complete details for an email sent as part of an Apollo sequence. This includes the contents of the emails, stats related to the email such as opens and clicks, and details about the contact that received the email.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"get_emailstats","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":"{\n \"activities\": [\n {\n \"id\": \"684b2203a2ce950021cbf730\",\n \"type\": \"emailer_message\",\n \"emailer_message_id\": \"684b2203a2ce950021cbf730\",\n \"emailer_message\": {\n \"id\": \"684b2203a2ce950021cbf730\",\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"status\": \"completed\",\n \"time_zone\": \"America/Los_Angeles\",\n \"provider_message_id\": \"1976610a368f41f9\",\n \"to_name\": \"Gina Larkin\",\n \"due_at\": \"2025-06-12T21:32:10.580+00:00\",\n \"completed_at\": \"2025-06-12T21:34:16.411+00:00\",\n \"emailer_touch_id\": \"684b216ec95a4f001d968d1b\",\n \"emailer_campaign_id\": \"684b215edf80730019db612c\",\n \"emailer_step_id\": \"684b216ec95a4f001d968d19\",\n \"failed_at\": \"2025-06-12T19:04:06.820+00:00\",\n \"failure_reason\": \"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\",\n \"attachment_ids\": [],\n \"enable_tracking\": true,\n \"type\": \"outreach_automatic_email\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"provider_thread_id\": \"197660da712c817b\",\n \"schedule_delayed_reason\": null,\n \"demoed\": null,\n \"email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"due_at_manually_changed\": true,\n \"not_sent_reason\": \"account_stage_safeguard\",\n \"bounce\": false,\n \"spam_blocked\": false,\n \"tracking_disabled_reason\": null,\n \"created_at\": \"2025-06-12T18:52:51.021Z\",\n \"async_sending\": false,\n \"due_at_source\": \"Email was sent using Send Now action\",\n \"crm_id\": null,\n \"replied\": null,\n \"needs_dynamic_assemble\": false,\n \"personalized_opener\": null,\n \"reply_class\": null,\n \"schedule_delayed_limit_reason\": null,\n \"schedule_delayed_reason_details\": null,\n \"sensitive_info_redacted\": null,\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"recipients\": [\n {\n \"email\": \"gina.larkin@apollo.io\",\n \"raw_name\": \"Gina Larkin\",\n \"recipient_type_cd\": \"to\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"user_id\": null\n }\n ],\n \"send_from\": {\n \"email\": \"test.marcus.hale@apollomail.io\",\n \"raw_name\": \"David Smith\",\n \"recipient_type_cd\": null,\n \"contact_id\": null,\n \"user_id\": null\n },\n \"from_email\": \"test.marcus.hale@apollomail.io\",\n \"to_email\": \"gina.larkin@apollo.io\",\n \"from_name\": \"David Smith\",\n \"bcc_emails\": [],\n \"cc_emails\": [],\n \"send_from_info\": \"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\",\n \"body_text\": \"Check out my email now!\\nDavid SmithApollo Knowledge Base \",\n \"body_html\": \"
\\n
Check out my email now!
\\n
David Smith
\\n
Apollo Knowledge Base
\\n
\\n
\",\n \"body_html_loaded\": true,\n \"appendment_html\": \"\",\n \"appendment_html_loaded\": true,\n \"subject\": \"Stats for you\",\n \"emailer_message_events\": [],\n \"num_opens\": 0,\n \"num_clicks\": 0,\n \"campaign_name\": \"Stats Sequences DO NOT USE\",\n \"campaign_max_emails_per_day\": null,\n \"campaign_position\": 1,\n \"step_max_emails_per_day\": null\n }\n }\n ],\n \"emailer_message\": {\n \"id\": \"684b2203a2ce950021cbf730\",\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"status\": \"completed\",\n \"time_zone\": \"America/Los_Angeles\",\n \"provider_message_id\": \"1976610a368f41f9\",\n \"to_name\": \"Gina Larkin\",\n \"due_at\": \"2025-06-12T21:32:10.580+00:00\",\n \"completed_at\": \"2025-06-12T21:34:16.411+00:00\",\n \"emailer_touch_id\": \"684b216ec95a4f001d968d1b\",\n \"emailer_campaign_id\": \"684b215edf80730019db612c\",\n \"emailer_step_id\": \"684b216ec95a4f001d968d19\",\n \"failed_at\": \"2025-06-12T19:04:06.820+00:00\",\n \"failure_reason\": \"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\",\n \"attachment_ids\": [],\n \"enable_tracking\": true,\n \"type\": \"outreach_automatic_email\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"provider_thread_id\": \"197660da712c817b\",\n \"schedule_delayed_reason\": null,\n \"demoed\": null,\n \"email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"due_at_manually_changed\": true,\n \"not_sent_reason\": \"account_stage_safeguard\",\n \"bounce\": false,\n \"spam_blocked\": false,\n \"tracking_disabled_reason\": null,\n \"created_at\": \"2025-06-12T18:52:51.021Z\",\n \"async_sending\": false,\n \"due_at_source\": \"Email was sent using Send Now action\",\n \"crm_id\": null,\n \"replied\": null,\n \"needs_dynamic_assemble\": false,\n \"personalized_opener\": null,\n \"reply_class\": null,\n \"schedule_delayed_limit_reason\": null,\n \"schedule_delayed_reason_details\": null,\n \"sensitive_info_redacted\": null,\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"recipients\": [\n {\n \"email\": \"gina.larkin@apollo.io\",\n \"raw_name\": \"Gina Larkin\",\n \"recipient_type_cd\": \"to\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"user_id\": null\n }\n ],\n \"send_from\": {\n \"email\": \"test.marcus.hale@apollomail.io\",\n \"raw_name\": \"David Smith\",\n \"recipient_type_cd\": null,\n \"contact_id\": null,\n \"user_id\": null\n },\n \"from_email\": \"test.marcus.hale@apollomail.io\",\n \"to_email\": \"gina.larkin@apollo.io\",\n \"from_name\": \"David Smith\",\n \"bcc_emails\": [],\n \"cc_emails\": [],\n \"send_from_info\": \"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\",\n \"body_text\": \"Check out my email now!\\nDavid SmithApollo Knowledge Base \",\n \"body_html\": \"
\\n
Check out my email now!
\\n
David Smith
\\n
Apollo Knowledge Base
\\n
\\n
\",\n \"body_html_loaded\": true,\n \"appendment_html\": \"\",\n \"appendment_html_loaded\": true,\n \"subject\": \"Stats for you\",\n \"contact\": {\n \"contact_roles\": [],\n \"id\": \"66ad20ab23d5d40001c8d07d\",\n \"first_name\": \"Gina\",\n \"last_name\": \"Larkin\",\n \"name\": \"Gina Larkin\",\n \"linkedin_url\": \"http://www.linkedin.com/in/gina-larkin-2e7a4d91\",\n \"title\": \"Technical Writer\",\n \"contact_stage_id\": \"6095a710bd01d100a506d4af\",\n \"owner_id\": null,\n \"creator_id\": \"669d3cf0105057019a5aca3c\",\n \"person_id\": \"667a2eb71b47190001e2ef42\",\n \"email_needs_tickling\": false,\n \"organization_name\": \"Apollo.io\",\n \"source\": \"chrome_extension_salesforce\",\n \"original_source\": \"email_import\",\n \"organization_id\": \"5e66b6381e05b4008c8331b8\",\n \"headline\": \"Technical Writer @ Apollo.io\",\n \"photo_url\": null,\n \"present_raw_address\": \"Hillsboro, Oregon, United States\",\n \"linkedin_uid\": null,\n \"extrapolated_email_confidence\": null,\n \"salesforce_id\": null,\n \"salesforce_lead_id\": null,\n \"salesforce_contact_id\": null,\n \"salesforce_account_id\": null,\n \"crm_owner_id\": null,\n \"created_at\": \"2024-08-02T18:08:43.785Z\",\n \"emailer_campaign_ids\": [\n \"684b215edf80730019db612c\"\n ],\n \"direct_dial_status\": null,\n \"direct_dial_enrichment_failed_at\": null,\n \"city\": \"Hillsboro\",\n \"country\": \"United States\",\n \"state\": \"Oregon\",\n \"email_status\": \"verified\",\n \"email_source\": \"gmail_directory\",\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"last_activity_date\": \"2025-06-12T21:34:16.000+00:00\",\n \"hubspot_vid\": null,\n \"hubspot_company_id\": null,\n \"crm_id\": null,\n \"sanitized_phone\": \"+14155550181\",\n \"merged_crm_ids\": null,\n \"updated_at\": \"2025-06-12T21:34:16.792Z\",\n \"queued_for_crm_push\": null,\n \"suggested_from_rule_engine_config_id\": null,\n \"email_unsubscribed\": null,\n \"person_deleted\": null,\n \"call_opted_out\": null,\n \"label_ids\": [],\n \"has_pending_email_arcgate_request\": false,\n \"has_email_arcgate_request\": false,\n \"existence_level\": \"full\",\n \"email\": \"gina.larkin@apollo.io\",\n \"email_from_customer\": null,\n \"typed_custom_fields\": {},\n \"custom_field_errors\": {},\n \"crm_record_url\": null,\n \"email_status_unavailable_reason\": null,\n \"email_true_status\": \"Verified\",\n \"updated_email_true_status\": true,\n \"source_display_name\": \"Imported from Salesforce\",\n \"twitter_url\": null,\n \"facebook_url\": null,\n \"contact_emails\": [\n {\n \"email_md5\": \"407887565213a5673207e861ac3523a3\",\n \"email_sha256\": \"1e86ff1e4d45ea7321e8b39e604fea05e3bde13ff689ddf78afeccce4e53e4e6\",\n \"email_status\": \"verified\",\n \"extrapolated_email_confidence\": null,\n \"position\": 0,\n \"email\": \"gina.larkin@apollo.io\",\n \"free_domain\": false,\n \"source\": \"Apollo\",\n \"third_party_vendor_name\": null,\n \"vendor_validation_statuses\": [],\n \"email_needs_tickling\": false,\n \"email_true_status\": \"Verified\",\n \"email_status_unavailable_reason\": null\n }\n ],\n \"time_zone\": \"America/Los_Angeles\",\n \"intent_strength\": null,\n \"show_intent\": false,\n \"phone_numbers\": [\n {\n \"raw_number\": \"+1 415-555-0181\",\n \"sanitized_number\": \"+14155550181\",\n \"type\": \"work_hq\",\n \"position\": 0,\n \"status\": \"no_status\",\n \"dnc_status\": null,\n \"dnc_other_info\": {},\n \"dialer_flags\": null,\n \"source_name\": \"Apollo\",\n \"vendor_validation_statuses\": [],\n \"third_party_vendor_name\": null\n }\n ],\n \"account_phone_note\": null,\n \"free_domain\": false,\n \"email_domain_catchall\": false\n },\n \"emailer_message_events\": [],\n \"num_opens\": 0,\n \"num_clicks\": 0,\n \"campaign_name\": \"Stats Sequences DO NOT USE\",\n \"campaign_max_emails_per_day\": null,\n \"campaign_position\": 1,\n \"step_max_emails_per_day\": null\n }\n}"}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/emailer_messages/activities is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"Email Not Available - Check ID":{"value":"{\n \"error\": \"Could not find message.\"\n}","summary":"Email Not Available - Check ID"}}}}}},"parameters":[{"in":"path","name":"id","description":"The ID for the email you want to view.

Each outreach email in Apollo is assigned a unique ID. To find email IDs, call the Search for Outreach Emails endpoint and identify the `id` value for the email.

Example: `684b2203a2ce950021cbf730`","schema":{"type":"string"},"required":true}]}},"/emailer_messages/search":{"get":{"summary":"Search for Outreach Emails","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Search for Outreach Emails endpoint to find emails that your team has created and sent as part of Apollo sequences.

To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"emailer_messages/search","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":"{\n {\n \"breadcrumbs\": [],\n \"emailer_messages\": [\n {\n \"id\": \"684b2203a2ce950021cbf730\",\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"status\": \"failed\",\n \"time_zone\": \"America/Los_Angeles\",\n \"provider_message_id\": null,\n \"to_name\": \"Gina Larkin\",\n \"due_at\": \"2025-06-12T18:57:08.553+00:00\",\n \"completed_at\": null,\n \"emailer_touch_id\": \"684b216ec95a4f001d968d1b\",\n \"emailer_campaign_id\": \"684b215edf80730019db612c\",\n \"emailer_step_id\": \"684b216ec95a4f001d968d19\",\n \"failed_at\": \"2025-06-12T19:04:06.820+00:00\",\n \"failure_reason\": \"Account stage is Active Opportunity. Change stage for account or adjust settings under Sequence => Settings and retry.\",\n \"attachment_ids\": [],\n \"enable_tracking\": true,\n \"type\": \"outreach_automatic_email\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"provider_thread_id\": null,\n \"schedule_delayed_reason\": null,\n \"demoed\": null,\n \"email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"due_at_manually_changed\": true,\n \"not_sent_reason\": \"account_stage_safeguard\",\n \"bounce\": null,\n \"spam_blocked\": null,\n \"tracking_disabled_reason\": null,\n \"created_at\": \"2025-06-12T18:52:51.021Z\",\n \"async_sending\": true,\n \"due_at_source\": \"Email was sent using Send Now action\",\n \"crm_id\": null,\n \"replied\": null,\n \"needs_dynamic_assemble\": true,\n \"personalized_opener\": null,\n \"reply_class\": null,\n \"schedule_delayed_limit_reason\": null,\n \"schedule_delayed_reason_details\": null,\n \"sensitive_info_redacted\": null,\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"recipients\": [\n {\n \"email\": \"gina.larkin@apollo.io\",\n \"raw_name\": \"Gina Larkin\",\n \"recipient_type_cd\": \"to\",\n \"contact_id\": \"66ad20ab23d5d40001c8d07d\",\n \"user_id\": null\n }\n ],\n \"send_from\": {\n \"email\": \"test.marcus.hale@apollomail.io\",\n \"raw_name\": \"David Smith\",\n \"recipient_type_cd\": null,\n \"contact_id\": null,\n \"user_id\": null\n },\n \"from_email\": \"test.marcus.hale@apollomail.io\",\n \"to_email\": \"gina.larkin@apollo.io\",\n \"from_name\": \"David Smith\",\n \"bcc_emails\": [],\n \"cc_emails\": [],\n \"send_from_info\": \"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\",\n \"body_text\": \"Check out my email now!David SmithApollo Knowledge Base \",\n \"body_html\": \"
Check out my email now!

David Smith
Apollo Knowledge Base
\",\n \"body_html_loaded\": true,\n \"appendment_html\": \"\",\n \"appendment_html_loaded\": true,\n \"subject\": \"Stats for you\",\n \"campaign_name\": \"Stats Sequences DO NOT USE\",\n \"campaign_max_emails_per_day\": null,\n \"campaign_position\": 1,\n \"step_max_emails_per_day\": null\n },\n {\n \"id\": \"684b2203a2ce950021cbf72d\",\n \"user_id\": \"66302798d03b9601c7934ebf\",\n \"status\": \"failed\",\n \"time_zone\": \"America/Los_Angeles\",\n \"provider_message_id\": null,\n \"to_name\": \"Wesley Tran\",\n \"due_at\": \"2025-06-12T18:57:14.197+00:00\",\n \"completed_at\": null,\n \"emailer_touch_id\": \"684b216ec95a4f001d968d1b\",\n \"emailer_campaign_id\": \"684b215edf80730019db612c\",\n \"emailer_step_id\": \"684b216ec95a4f001d968d19\",\n \"failed_at\": \"2025-06-12T19:04:09.180+00:00\",\n \"failure_reason\": \"Contact stage is Interested. Change stage for contact or adjust settings under Sequence => Settings and retry.\",\n \"attachment_ids\": [],\n \"enable_tracking\": true,\n \"type\": \"outreach_automatic_email\",\n \"contact_id\": \"6601a68fca35d8000718d42b\",\n \"provider_thread_id\": null,\n \"schedule_delayed_reason\": null,\n \"demoed\": null,\n \"email_account_id\": \"6633baaece5fbd01c791d7ca\",\n \"due_at_manually_changed\": true,\n \"not_sent_reason\": \"contact_stage_safeguard\",\n \"bounce\": null,\n \"spam_blocked\": null,\n \"tracking_disabled_reason\": null,\n \"created_at\": \"2025-06-12T18:52:51.021Z\",\n \"async_sending\": true,\n \"due_at_source\": \"Email was sent using Send Now action\",\n \"crm_id\": null,\n \"replied\": null,\n \"needs_dynamic_assemble\": true,\n \"personalized_opener\": null,\n \"reply_class\": null,\n \"schedule_delayed_limit_reason\": null,\n \"schedule_delayed_reason_details\": null,\n \"sensitive_info_redacted\": null,\n \"account_id\": \"6518c6184f20350001a0b9c0\",\n \"recipients\": [\n {\n \"email\": \"wesley.t@example.com\",\n \"raw_name\": \"Wesley Tran\",\n \"recipient_type_cd\": \"to\",\n \"contact_id\": \"6601a68fca35d8000718d42b\",\n \"user_id\": null\n }\n ],\n \"send_from\": {\n \"email\": \"test.marcus.hale@apollomail.io\",\n \"raw_name\": \"David Smith\",\n \"recipient_type_cd\": null,\n \"contact_id\": null,\n \"user_id\": null\n },\n \"from_email\": \"test.marcus.hale@apollomail.io\",\n \"to_email\": \"wesley.t@example.com\",\n \"from_name\": \"David Smith\",\n \"bcc_emails\": [],\n \"cc_emails\": [],\n \"send_from_info\": \"6633baaece5fbd01c791d7ca***test.marcus.hale@apollomail.io\",\n \"body_text\": \"Check out my email now!David SmithApollo Knowledge Base \",\n \"body_html\": \"
Check out my email now!

David Smith
Apollo Knowledge Base
\",\n \"body_html_loaded\": true,\n \"appendment_html\": \"\",\n \"appendment_html_loaded\": true,\n \"subject\": \"Stats for you\",\n \"campaign_name\": \"Stats Sequences DO NOT USE\",\n \"campaign_max_emails_per_day\": null,\n \"campaign_position\": 1,\n \"step_max_emails_per_day\": null\n }\n ],\n \"emailer_steps\": [\n {\n \"id\": \"684b216ec95a4f001d968d19\",\n \"emailer_campaign_id\": \"684b215edf80730019db612c\",\n \"wait_time\": 0,\n \"wait_mode\": \"minute\",\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"auto_skip_in_x_days\": null,\n \"position\": 1\n },\n {\n \"id\": \"684886e2e7c9bd0011e0b239\",\n \"emailer_campaign_id\": \"6848868536ec86001d300ce6\",\n \"wait_time\": 30,\n \"wait_mode\": \"minute\",\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"auto_skip_in_x_days\": null,\n \"position\": 1\n },\n {\n \"id\": \"67bde6d5b5eeec0021ad09c4\",\n \"emailer_campaign_id\": \"67bde6d5b5eeec0021ad09c2\",\n \"wait_time\": 20,\n \"wait_mode\": \"day\",\n \"max_emails_per_day\": null,\n \"exact_datetime\": null,\n \"auto_skip_in_x_days\": null,\n \"position\": 1\n }\n ],\n \"num_fetch_result\": null\n}"}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/usage_stats/api_usage_stats is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}}},"parameters":[{"name":"emailer_message_stats[]","in":"query","required":false,"description":"Find emails based on their current status, such as whether they were delivered or opened. You can add multiple statuses.

Possible values include: ","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"emailer_message_reply_classes[]","in":"query","required":false,"description":"Find emails based on the response sentiment of the recipient. This can include the recipient expressing interest in meeting or having a follow-up question. You can add multiple values.

Possible values include: ","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"user_ids[]","in":"query","required":false,"description":"Find emails sent by specific users in your team's Apollo account. You can add multiple users.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `66302798d03b9601c7934ebf`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"email_account_id_and_aliases","in":"query","required":false,"description":"","schema":{"type":"string","default":""}},{"name":"emailer_campaign_ids[]","in":"query","required":false,"description":"Search for emails that are included in specific sequences in your Apollo account. You can search multiple sequences. Any sequence not included in this parameter will be exclude from search results.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"not_emailer_campaign_ids[]","in":"query","required":false,"description":"Exclude emails from specific sequences in your Apollo account. You can exclude multiple sequences. Any sequence not excluded using this parameter will be included in search results.

To find sequence IDs, call the Search for Sequences endpoint and identify the `id` value for the sequence.

Example: `66e9e215ece19801b219997f`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"emailer_message_date_range_mode","in":"query","required":false,"description":"Use this parameter in combination with the `emailer_message_date_range[max]` and `emailer_message_date_range[min]` parameters. Find emails based on 1 of the following options: ","schema":{"type":"string","default":""}},{"name":"emailer_message_date_range[max]","in":"query","required":false,"description":"Set the upper bound of the date range you want to search.

Use this parameter in combination with the `emailer_message_date_range[min]` and `emailer_message_date_range_mode` parameters. This date should fall after the `emailer_message_date_range[min]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`","schema":{"type":"string","format":"date","default":""}},{"name":"emailer_message_date_range[min]","in":"query","required":false,"description":"Set the lower bound of the date range you want to search.

Use this parameter in combination with the `emailer_message_date_range[max]` and `emailer_message_date_range_mode` parameters. This date should fall before the `emailer_message_date_range[max]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-10-30`","schema":{"type":"string","format":"date","default":""}},{"name":"not_sent_reason_cds[]","in":"query","required":false,"description":"Find emails based on the reason they were not sent. You can add multiple values.

Possible values include: ","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"q_keywords","in":"query","required":false,"description":"Add keywords to narrow the search of the emails in your team's Apollo account.

Keywords should directly match at least part of an email's content. For example, searching the keyword `James` might return emails that were sent by `James Smith`.

Example: `Jane`","schema":{"type":"string","default":""}},{"name":"page","in":"query","description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","format":"int32"}}]}},"/webhook_result/{request_id}":{"get":{"summary":"Poll Webhook Result","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Poll Webhook Result endpoint to retrieve webhook results from Apollo. This endpoint enables you to poll for the webhook payload if you didn't receive the original webhook callback.

To use this endpoint, you need the request_id from the People Enrichment or Bulk People Enrichment endpoint. Pass this value as request_id in this endpoint.

This endpoint returns webhook results for your team from up to thirty days after the webhook was triggered.","tags":["Miscellaneous"],"operationId":"poll-webhook-result","parameters":[{"name":"request_id","in":"path","required":true,"description":"The request_id returned when the original enrichment request was submitted. This value is an integer and can be positive or negative.

Example: 1039995589705121900","schema":{"type":"integer"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Phone enrichment":{"value":{"request_id":"1039995589705121900","webhook_status":"success","request_type":"phone","last_dispatched_at":"2026-05-26T10:42:11Z","failure_reason":null,"webhook_result":{"status":"success","total_requested_enrichments":1,"unique_enriched_records":1,"missing_records":0,"credits_consumed":1,"people":[{"id":"587cf802f65125cad923a266","status":"success","phone_numbers":[{"_id":"64dbe6d172c24f00017b9b71","confidence_cd":"high","created_at":null,"direct_dial_source_cd":"contact_trusted","dnc_other_info":{"country":"United States"},"dnc_status_cd":"not_found","dnc_status_updated_at":"2023-08-15T20:57:53.108+00:00","position":0,"raw_number":"+1 555-555-0164","sanitized_number":"+15555550164","status_cd":"valid_number","type_cd":"other","updated_at":null,"id":"64dbe6d172c24f00017b9b71","key":"64dbe6d172c24f00017b9b71"},{"_id":"64dbe6d172c24f00017b9b72","confidence_cd":"high","created_at":null,"direct_dial_source_cd":"contact_trusted","dnc_other_info":{"country":"United States"},"dnc_status_cd":"not_found","dnc_status_updated_at":"2023-08-15T20:57:53.267+00:00","position":1,"raw_number":"+1 415-555-0117","sanitized_number":"+14155550117","status_cd":"valid_number","type_cd":"other","updated_at":null,"id":"64dbe6d172c24f00017b9b72","key":"64dbe6d172c24f00017b9b72"}]}]}}},"Waterfall enrichment":{"value":{"request_id":"1039995589705121900","webhook_status":"success","request_type":"waterfall","last_dispatched_at":"2026-05-26T10:42:11Z","failure_reason":null,"webhook_result":{"status":"success","total_requested_enrichments":1,"target_fields":["emails","phone_numbers"],"records_enriched":1,"email_records_enriched":1,"mobile_records_enriched":1,"enrichment_not_found":0,"email_records_not_found":0,"mobile_records_not_found":0,"credits_consumed":0,"request_id":"1039995589705121900","request_initiated":"2026-01-08T08:05:49Z","request_completed":"2026-01-08T08:10:56Z","people":[{"id":"695f655dc46b8364aefc80c0","waterfall":{"emails":[{"vendors":[{"id":"icypeas_single_email_search-1","name":"Icypeas","status":"UNVERIFIED","emails":["email1@example.com"],"usedForVerification":false,"statusCode":null,"statusMessage":null,"authMechanism":"native"}]}],"phone_numbers":[{"vendors":[{"id":"prospeo_mobile_finder-1","name":"Prospeo","status":"UNVERIFIED","phone_numbers":["916-555-0111"],"usedForVerification":false,"statusCode":null,"statusMessage":null,"authMechanism":"native"}]}]},"phone_numbers":[{"_id":"695f668dc46b8364aefc80fa","confidence_cd":null,"dnc_other_info":{},"dnc_status_cd":null,"dnc_status_updated_at":null,"raw_number":"916-555-0111","sanitized_number":"+19165550111","status_cd":"no_status","type_cd":null,"id":"695f668dc46b8364aefc80fa","key":"695f668dc46b8364aefc80fa"}],"emails":[{"email":"email1@example.com","email_source_cd":null,"position":0,"email_status_cd":"Verified","extrapolated_email_confidence":null,"third_party_data_provider_id":"icypeas_single_email_search","waterfall_enriched_at":"2026-01-08T08:05:50.241Z","vendor_validation_statuses":[]}]}]}}}},"schema":{"type":"object","properties":{"request_id":{"type":"string","description":"Echoes the request_id from the URL.","example":"1039995589705121900"},"webhook_status":{"type":"string","description":"The current webhook status.","enum":["in_progress","success","failed"],"example":"success"},"request_type":{"type":"string","description":"The enrichment request type.","enum":["email","phone","waterfall"],"example":"phone"},"last_dispatched_at":{"type":"string","nullable":true,"description":"ISO 8601 UTC timestamp of the last webhook POST attempt. Returns null until Apollo makes the first dispatch attempt.","example":"2026-05-26T10:42:11Z"},"failure_reason":{"type":"string","nullable":true,"description":"The error message from the last failed dispatch. This field is populated when webhook_status is failed.","example":null},"webhook_result":{"type":"object","nullable":true,"description":"The original webhook payload that Apollo delivered, or would have delivered, to the customer webhook URL. The shape varies by request_type.","additionalProperties":true}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Unauthorized":{"value":"Invalid access credentials."}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Record missing our outside window":{"value":{"retry_after_seconds":10,"message":"Webhook result older than 30 days is not available. Please ensure you are not requesting a result that is older than 30 days."}}},"schema":{"type":"object","properties":{"retry_after_seconds":{"type":"integer","description":"The number of seconds to wait before retrying the request. This value does not guarantee that phone or email enrichment results will be available after 10 seconds.","example":10},"message":{"type":"string","description":"Message with additional information about the response.","example":"Webhook result older than 30 days is not available. Please ensure you are not requesting a result that is older than 30 days."}}}}}}},"deprecated":false}},"/usage_stats/api_usage_stats":{"post":{"summary":"View API Usage Stats and Rate Limits","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the View API Usage Stats endpoint to view your team's usage of Apollo API and your rate limit for API endpoints.

Each endpoint has a rate limit per minute, hour, and day. Your Apollo plan does impact the rate limits for API endpoints.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Miscellaneous"],"operationId":"post_apiusage","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":"{\n \"[\\\"api/v1/contacts\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 500,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 5,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 10,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/contacts\\\", \\\"intelligent_fuzzy_search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/contacts\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/contacts\\\", \\\"update\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/contacts\\\", \\\"match\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/contacts\\\", \\\"bulk_match\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 100,\n \"consumed\": 0,\n \"left_over\": 100\n },\n \"minute\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n }\n },\n \"[\\\"api/v1/contact_stages\\\", \\\"index\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/accounts\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/account_stages\\\", \\\"index\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/people\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/people\\\", \\\"match\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/people\\\", \\\"bulk_match\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 100,\n \"consumed\": 0,\n \"left_over\": 100\n },\n \"minute\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n }\n },\n \"[\\\"api/v1/people\\\", \\\"show\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"show\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 3,\n \"left_over\": 5997\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 3,\n \"left_over\": 597\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"show_with_context\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 3,\n \"left_over\": 5997\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 3,\n \"left_over\": 597\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"enrich\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"bulk_enrich\\\"]\": {\n \"day\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"hour\": {\n \"limit\": 100,\n \"consumed\": 0,\n \"left_over\": 100\n },\n \"minute\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"job_postings\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/organizations\\\", \\\"employee_metrics\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/mixed_companies\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/mixed_people\\\", \\\"add_to_my_prospects\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 1,\n \"left_over\": 5999\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 100,\n \"consumed\": 0,\n \"left_over\": 100\n }\n },\n \"[\\\"api/v1/mixed_people\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 10,\n \"left_over\": 5990\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 10,\n \"left_over\": 590\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 1,\n \"left_over\": 199\n }\n },\n \"[\\\"api/v1/mixed_people\\\", \\\"organization_top_people\\\"]\": {\n \"day\": {\n \"limit\": 2000,\n \"consumed\": 0,\n \"left_over\": 2000\n },\n \"hour\": {\n \"limit\": 400,\n \"consumed\": 0,\n \"left_over\": 400\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/conversation_shares\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/conversation_shares\\\", \\\"update\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/conversation_shares\\\", \\\"show\\\"]\": {\n \"day\": {\n \"limit\": 300,\n \"consumed\": 0,\n \"left_over\": 300\n },\n \"hour\": {\n \"limit\": 50,\n \"consumed\": 0,\n \"left_over\": 50\n },\n \"minute\": {\n \"limit\": 10,\n \"consumed\": 0,\n \"left_over\": 10\n }\n },\n \"[\\\"api/v1/conversation_shares\\\", \\\"external\\\"]\": {\n \"day\": {\n \"limit\": 300,\n \"consumed\": 0,\n \"left_over\": 300\n },\n \"hour\": {\n \"limit\": 50,\n \"consumed\": 0,\n \"left_over\": 50\n },\n \"minute\": {\n \"limit\": 10,\n \"consumed\": 0,\n \"left_over\": 10\n }\n },\n \"[\\\"api/v1/conversations\\\", \\\"ask_anything_v2_chat\\\"]\": {\n \"day\": {\n \"limit\": 1000,\n \"consumed\": 0,\n \"left_over\": 1000\n },\n \"hour\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n },\n \"minute\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n }\n },\n \"[\\\"api/v1/conversations\\\", \\\"export\\\"]\": {\n \"day\": {\n \"limit\": 480,\n \"consumed\": 0,\n \"left_over\": 480\n },\n \"hour\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n },\n \"minute\": {\n \"limit\": 1,\n \"consumed\": 0,\n \"left_over\": 1\n }\n },\n \"[\\\"api/v1/voice_settings\\\", \\\"get_available_phone_numbers\\\"]\": {\n \"day\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n },\n \"hour\": {\n \"limit\": 50,\n \"consumed\": 0,\n \"left_over\": 50\n },\n \"minute\": {\n \"limit\": 10,\n \"consumed\": 0,\n \"left_over\": 10\n }\n },\n \"[\\\"api/v1/tasks\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/tasks\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 3,\n \"left_over\": 5997\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 3,\n \"left_over\": 597\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/tasks\\\", \\\"bulk_complete\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/reports\\\", \\\"sync_report\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 5,\n \"consumed\": 0,\n \"left_over\": 5\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/mfa_config\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 50,\n \"consumed\": 0,\n \"left_over\": 50\n },\n \"hour\": {\n \"limit\": 20,\n \"consumed\": 0,\n \"left_over\": 20\n },\n \"minute\": {\n \"limit\": 5,\n \"consumed\": 0,\n \"left_over\": 5\n }\n },\n \"[\\\"api/v1/phone_calls\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/phone_calls\\\", \\\"update\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/paging_events\\\", \\\"create\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 3,\n \"left_over\": 5997\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 1,\n \"left_over\": 599\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 1,\n \"left_over\": 199\n }\n },\n \"[\\\"api/v1/crm\\\", \\\"object_fields_mapping\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_campaigns\\\", \\\"show\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 2,\n \"left_over\": 5998\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_campaigns\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 2,\n \"left_over\": 5998\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_campaigns\\\", \\\"add_contact_ids\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_campaigns\\\", \\\"remove_or_stop_contact_ids\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_messages\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/emailer_messages\\\", \\\"activities\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/users\\\", \\\"search\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 4,\n \"left_over\": 5996\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/email_accounts\\\", \\\"index\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/labels\\\", \\\"index\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n },\n \"[\\\"api/v1/typed_custom_fields\\\", \\\"index\\\"]\": {\n \"day\": {\n \"limit\": 6000,\n \"consumed\": 0,\n \"left_over\": 6000\n },\n \"hour\": {\n \"limit\": 600,\n \"consumed\": 0,\n \"left_over\": 600\n },\n \"minute\": {\n \"limit\": 200,\n \"consumed\": 0,\n \"left_over\": 200\n }\n }\n0"}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials."}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":{"error":"api/v1/usage_stats/api_usage_stats is not accessible with this api_key","error_code":"API_INACCESSIBLE"},"summary":"Need Master API Key"}}}}}},"parameters":[]}},"/phone_calls":{"post":{"summary":"Create Call Records","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Create Call Records endpoint to log calls in Apollo that were made using outside systems such as Orum or Nooks. This endpoint can only be used create call records, not to dial prospects.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Calls"],"operationId":"phonecalls_create","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"phone_call":{"id":"6859b021b2d6e700212eaf3f","user_id":"67e33d527de088000daa60c4","account_id":"6518c6184f20350001a0b9c0","contact_id":"6601a68fca35d8000718d42b","voice_setting_id":null,"phone_call_outcome_id":"6095a710bd01d100a506d4c5","phone_call_purpose_id":"6095a710bd01d100a506d4cd","recording_url":null,"twilio_call_sid":null,"call_identifier":null,"agent_call_sid":null,"inbound":false,"from_number":null,"to_number":null,"start_time":"2025-06-23T19:50:57.292+00:00","end_time":"2025-06-23T19:50:57.292+00:00","transcription_too_long":null,"twilio_recording_sid":null,"need_recording_upload":true,"logged":true,"note":null,"status":"completed","outreach_task_id":null,"salesforce_id":null,"hubspot_id":null,"conference_id":null,"opportunity_id":null,"voicemail_dropped":false,"parallel_dial_item_id":null,"transcribed":false,"transcribing":false,"transcription_progress":0,"note_text":"","contact":{"contact_roles":[],"id":"6601a68fca35d8000718d42b","first_name":"Wesley","last_name":"Tran","name":"Wesley Tran","linkedin_url":"http://www.linkedin.com/in/wesley-tran-5a9c3e74","title":"Technical Support","contact_stage_id":"6095a710bd01d100a506d4af","owner_id":null,"creator_id":"60affe7d6e270a00f5db6fe4","person_id":"66f0b509f10e970001a0b1b0","email_needs_tickling":false,"organization_name":"Apollo.io","source":"search","original_source":"email_import","organization_id":"5e66b6381e05b4008c8331b8","headline":"Technical support","photo_url":null,"present_raw_address":"Portland, Oregon, United States","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-03-25T16:30:07.555Z","emailer_campaign_ids":["66a97236a8759801b5417678","6567758e12b81a0264ab0bb1","67be333b81ca47000d1cfb9f","684b215edf80730019db612c"],"direct_dial_status":"enrichment_failed","direct_dial_enrichment_failed_at":"2025-02-27T15:16:57.036+00:00","city":"Portland","country":"United States","state":"Oregon","email_status":"verified","email_source":"crm","account_id":"6518c6184f20350001a0b9c0","last_activity_date":"2025-06-23T19:50:57.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+14155550181","merged_crm_ids":null,"updated_at":"2025-06-23T19:50:57.325Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":["66a96f0cb2ef9801b486f3fd"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"wesley.t@example.com","email_from_customer":null,"typed_custom_fields":{"677c0c4f451bfb02cf105e01":"Hi Justin,\n\nTechnical writing requires precision and insight. At Apollo.io, we understand the challenges of creating impactful documentation that stands out in a competitive landscape.\n\nOur platform helps technical writers like you gain visibility, track performance metrics, and showcase your expertise across professional networks, potentially elevating your professional profile.\n\nWould you be open to a 15-minute call to explore how we can support your professional growth and recognition?\n\nSunny"},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"source_display_name":"Requested from Apollo","twitter_url":null,"facebook_url":null,"contact_emails":[{"email_md5":"210b056db397b0a452dbd967d19f9cb5","email_sha256":"a6ec970636a0a3c3fda95094cc2bb23a580ed900d7e96a517ad7694f657d8012","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"wesley.t@example.com","free_domain":false,"source":"Apollo","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":false,"email_true_status":"Verified","email_status_unavailable_reason":null}],"time_zone":"America/Los_Angeles","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 555-555-0164","sanitized_number":"+15555550164","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"Apollo","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false},"account":{"raw_address":"535 mission st, san francisco, california, united states, 94105","street_address":"535 Mission Street","city":"San Francisco","state":"California","country":"United States","postal_code":"94105","id":"6518c6184f20350001a0b9c0","domain":"apollo.io","name":"Apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":"6095a710bd01d100a506d4b9","source":"job_change","original_source":"job_change","creator_id":"60affe7d6e270a00f5db6fe4","owner_id":"66302798d03b9601c7934ec2","created_at":"2023-10-01T01:06:32.057Z","phone":"+1 415-555-0181","phone_status":"no_status","hubspot_id":null,"salesforce_id":"0017ntaJPTvuIbOUVM","crm_owner_id":"005dK4PthD6owdyIkD","parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+15555550164","account_playbook_statuses":[],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{"671932d76c03c402d0528199":["671932d76c03c402d0528195"]},"custom_field_errors":{},"modality":"account","source_display_name":"Job Change","salesforce_record_url":"https://orgfarm-1a2b3c4d5e-dev-ed.develop.my.salesforce.com/0017ntaJPTvuIbOUVM","crm_record_url":null,"twitter_url":null,"facebook_url":null,"intent_strength":null,"show_intent":false,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null},"duration":45},"contact":{"contact_roles":[],"id":"6601a68fca35d8000718d42b","first_name":"Wesley","last_name":"Tran","name":"Wesley Tran","linkedin_url":"http://www.linkedin.com/in/wesley-tran-5a9c3e74","title":"Technical Support","contact_stage_id":"6095a710bd01d100a506d4af","owner_id":null,"creator_id":"60affe7d6e270a00f5db6fe4","person_id":"66f0b509f10e970001a0b1b0","email_needs_tickling":false,"organization_name":"Apollo.io","source":"search","original_source":"email_import","organization_id":"5e66b6381e05b4008c8331b8","headline":"Technical support","photo_url":null,"present_raw_address":"Portland, Oregon, United States","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-03-25T16:30:07.555Z","emailer_campaign_ids":["66a97236a8759801b5417678","6567758e12b81a0264ab0bb1","67be333b81ca47000d1cfb9f","684b215edf80730019db612c"],"direct_dial_status":"enrichment_failed","direct_dial_enrichment_failed_at":"2025-02-27T15:16:57.036+00:00","city":"Portland","country":"United States","state":"Oregon","email_status":"verified","email_source":"crm","account_id":"6518c6184f20350001a0b9c0","last_activity_date":"2025-06-23T19:50:57.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+15555550164","merged_crm_ids":null,"updated_at":"2025-06-23T19:50:57.325Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":["66a96f0cb2ef9801b486f3fd"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"wesley.t@example.com","email_from_customer":null,"typed_custom_fields":{"677c0c4f451bfb02cf105e01":"Hi Justin,\n\nTechnical writing requires precision and insight. At Apollo.io, we understand the challenges of creating impactful documentation that stands out in a competitive landscape.\n\nOur platform helps technical writers like you gain visibility, track performance metrics, and showcase your expertise across professional networks, potentially elevating your professional profile.\n\nWould you be open to a 15-minute call to explore how we can support your professional growth and recognition?\n\nSunny"},"custom_field_errors":null,"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"source_display_name":"Requested from Apollo","twitter_url":null,"facebook_url":null,"contact_campaign_statuses":[{"id":"66a977e82a86cb000139ceff","emailer_campaign_id":"66a97236a8759801b5417678","send_email_from_user_id":"66a3d80d4238fe02d2baaaaf","inactive_reason":"replied","status":"finished","added_at":"2024-07-30T23:31:51.991+00:00","added_by_user_id":"66a3d80d4238fe02d2baaaaf","finished_at":"2024-10-08T16:51:24.185+00:00","paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"priya.nadkarni@apollomail.io","send_email_from_email_account_id":"66a423655825e8019ae89db6","manually_set_unpause":null,"failure_reason":null,"current_step_id":"66a97236a8759801b541767d","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":3},{"id":"6708721db13a0a000190999c","emailer_campaign_id":"6567758e12b81a0264ab0bb1","send_email_from_user_id":"66a3d80d4238fe02d2baaaaf","inactive_reason":"User deleted","status":"failed","added_at":"2024-10-11T00:32:29.857+00:00","added_by_user_id":"60affe7d6e270a00f5db6fe4","finished_at":null,"paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"priya.nadkarni@apollomail.io","send_email_from_email_account_id":"66a423655825e8019ae89db6","manually_set_unpause":null,"failure_reason":"user_deleted","current_step_id":null,"in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":null},{"id":"680bd68fbfaec40015b9b32b","emailer_campaign_id":"67be333b81ca47000d1cfb9f","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":null,"status":"active","added_at":"2025-04-25T18:38:07.090+00:00","added_by_user_id":"66302798d03b9601c7934ebf","finished_at":null,"paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":null,"current_step_id":"67be333b81ca47000d1cfba0","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":2},{"id":"684b21d0de0df60015d2218d","emailer_campaign_id":"684b215edf80730019db612c","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":"Completed last step","status":"finished","added_at":"2025-06-12T18:52:00.914+00:00","added_by_user_id":"66302798d03b9601c7934ebf","finished_at":"2025-06-12T21:34:16.705+00:00","paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":"contact_stage_safeguard","current_step_id":"684b216ec95a4f001d968d19","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":1}],"contact_emails":[{"email_md5":"210b056db397b0a452dbd967d19f9cb5","email_sha256":"a6ec970636a0a3c3fda95094cc2bb23a580ed900d7e96a517ad7694f657d8012","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"wesley.t@example.com","free_domain":false,"source":"Apollo","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":false,"email_true_status":"Verified","email_status_unavailable_reason":null}],"time_zone":"America/Los_Angeles","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 555-555-0164","sanitized_number":"+15555550164","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"Apollo","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false},"team":{"id":"6095a710bd01d100a506d4ac","phone_calls_finder_empty":false}}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/usage_stats/api_usage_stats is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}}},"parameters":[{"name":"logged","in":"query","required":false,"description":"Set to `true` if you want to create an individual record for the phone call in Apollo.","schema":{"type":"boolean","default":""}},{"name":"user_id[]","in":"query","required":false,"description":"Designate the caller in your team's Apollo account.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `67e33d527de088000daa60c4`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"contact_id","in":"query","required":false,"description":"Designate the contact that was called.

Use the Search for Contacts endpoint to retrieve IDs for all of the contacts within your Apollo account.

Example: `66e34b81740c50074e3d1bd4`","schema":{"type":"string","default":""}},{"name":"account_id","in":"query","required":false,"description":"Associate the call with an account.

Use the Search for Accounts endpoint to retrieve IDs for all of the accounts within your Apollo account.

Example: `66e9abf95ac32901b20d1a0d`","schema":{"type":"string","default":""}},{"name":"to_number","in":"query","required":false,"description":"The phone number that you dialed.

Example: `5555550164`","schema":{"type":"string","default":""}},{"name":"from_number","in":"query","required":false,"description":"The phone number that dialed you.

Example: `5555550164`","schema":{"type":"string","default":""}},{"name":"status","in":"query","required":false,"description":"The status of the phone call. Possible values include: ","schema":{"type":"string","default":""}},{"name":"start_time","in":"query","required":false,"description":"The time when the call started.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a start time that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifiying in hours and minutes how much you want to offset GMT.

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`","schema":{"type":"string","format":"date-time","default":""}},{"name":"end_time","in":"query","required":false,"description":"The time when the call ended.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a end time that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifiying in hours and minutes how much you want to offset GMT.

Example: `2025-05-15T08:10:30Z`; `2025-05-25T10:15:30+05:00Z`","schema":{"type":"string","format":"date-time","default":""}},{"name":"duration","in":"query","required":false,"description":"The duration of the call in seconds. Do not enter minutes.

Examples: `120`; `205`","schema":{"type":"integer","default":""}},{"name":"phone_call_purpose_id","in":"query","required":false,"description":"Assign a call purpose to the record.

Call purposes are unique to your team's Apollo account. When you use the Purpose search filter for calls in the Apollo product, you can find the corresponding call purpose ID in the URL.

Examples: `6095a710bd01d100a506d4cd`","schema":{"type":"string","default":""}},{"name":"phone_call_outcome_id","in":"query","required":false,"description":"Assign a call outcome to the record.

Call outcomes are unique to your team's Apollo account. When you use the Disposition search filter for calls in the Apollo product, you can find the corresponding call outcome ID in the URL.

Examples: `6095a710bd01d100a506d4c5`","schema":{"type":"string","default":""}},{"name":"note","in":"query","required":false,"description":"Add a note to the call record.

Example: `This lead is interested in learning more about our new product line.`","schema":{"type":"string","default":""}}]}},"/phone_calls/{id}":{"put":{"summary":"Update Call Records","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Update Call Records endpoint to update your team's call records in Apollo.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Calls"],"operationId":"put_phone_callsupdate","responses":{"200":{"description":"OK","content":{"application/json":{"examples":{"OK":{"value":{"phone_call":{"id":"6859b0dd828b270021e69648","user_id":"66302798d03b9601c7934ebf","account_id":"6518c6184f20350001a0b9c0","contact_id":"6601a68fca35d8000718d42b","voice_setting_id":null,"phone_call_outcome_id":"6095a710bd01d100a506d4c5","phone_call_purpose_id":"6095a710bd01d100a506d4cd","recording_url":null,"twilio_call_sid":null,"call_identifier":null,"agent_call_sid":null,"inbound":false,"from_number":null,"to_number":null,"start_time":"2025-06-23T19:54:05.190+00:00","end_time":"2025-06-23T19:54:05.190+00:00","transcription_too_long":null,"twilio_recording_sid":null,"need_recording_upload":true,"logged":true,"note":"I forgot to add a note about this contact's desire to discuss APIs.","status":"completed","outreach_task_id":null,"salesforce_id":null,"hubspot_id":null,"conference_id":null,"opportunity_id":null,"voicemail_dropped":false,"parallel_dial_item_id":null,"transcribed":false,"transcribing":false,"transcription_progress":0,"note_text":"I forgot to add a note about this contact's desire to discuss APIs.","contact":{"contact_roles":[],"id":"6601a68fca35d8000718d42b","first_name":"Wesley","last_name":"Tran","name":"Wesley Tran","linkedin_url":"http://www.linkedin.com/in/wesley-tran-5a9c3e74","title":"Technical Writer II","contact_stage_id":"6095a710bd01d100a506d4af","owner_id":null,"creator_id":"60affe7d6e270a00f5db6fe4","person_id":"66f0b509f10e970001a0b1b0","email_needs_tickling":false,"organization_name":"Apollo.io","source":"search","original_source":"email_import","organization_id":"5e66b6381e05b4008c8331b8","headline":"Technical writer","photo_url":null,"present_raw_address":"Portland, Oregon, United States","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-03-25T16:30:07.555Z","emailer_campaign_ids":["66a97236a8759801b5417678","6567758e12b81a0264ab0bb1","67be333b81ca47000d1cfb9f","684b215edf80730019db612c"],"direct_dial_status":"enrichment_failed","direct_dial_enrichment_failed_at":"2025-02-27T15:16:57.036+00:00","city":"Portland","country":"United States","state":"Oregon","email_status":"verified","email_source":"crm","account_id":"6518c6184f20350001a0b9c0","last_activity_date":"2025-06-23T19:54:36.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+14155550181","merged_crm_ids":null,"updated_at":"2025-06-23T19:54:36.183Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":["66a96f0cb2ef9801b486f3fd"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"wesley.t@example.com","email_from_customer":null,"typed_custom_fields":{},"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"source_display_name":"Requested from Apollo","twitter_url":null,"facebook_url":null,"contact_emails":[{"email_md5":"210b056db397b0a452dbd967d19f9cb5","email_sha256":"a6ec970636a0a3c3fda95094cc2bb23a580ed900d7e96a517ad7694f657d8012","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"wesley.t@example.com","free_domain":false,"source":"Apollo","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":false,"email_true_status":"Verified","email_status_unavailable_reason":null}],"time_zone":"America/Los_Angeles","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 415-555-0181","sanitized_number":"+14155550181","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"Apollo","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false},"account":{"raw_address":"535 mission st, san francisco, california, united states, 94105","street_address":"535 Mission Street","city":"San Francisco","state":"California","country":"United States","postal_code":"94105","id":"6518c6184f20350001a0b9c0","domain":"apollo.io","name":"Apollo.io","team_id":"6095a710bd01d100a506d4ac","organization_id":"5e66b6381e05b4008c8331b8","account_stage_id":"6095a710bd01d100a506d4b9","source":"job_change","original_source":"job_change","creator_id":"60affe7d6e270a00f5db6fe4","owner_id":"66302798d03b9601c7934ec2","created_at":"2023-10-01T01:06:32.057Z","phone":"+1 415-555-0181","phone_status":"no_status","hubspot_id":null,"salesforce_id":"0017ntaJPTvuIbOUVM","crm_owner_id":"005dK4PthD6owdyIkD","parent_account_id":null,"linkedin_url":null,"sanitized_phone":"+14155550181","account_playbook_statuses":[],"existence_level":"full","label_ids":["6504905b21ba8e00a334eb0f"],"typed_custom_fields":{"671932d76c03c402d0528199":["671932d76c03c402d0528195"]},"custom_field_errors":{},"modality":"account","source_display_name":"Job Change","salesforce_record_url":"https://orgfarm-1a2b3c4d5e-dev-ed.develop.my.salesforce.com/0017ntaJPTvuIbOUVM","crm_record_url":null,"twitter_url":null,"facebook_url":null,"intent_strength":null,"show_intent":false,"organization_headcount_six_month_growth":null,"organization_headcount_twelve_month_growth":null,"organization_headcount_twenty_four_month_growth":null},"duration":150},"contact":{"id":"6601a68fca35d8000718d42b","contact_roles":[],"first_name":"Wesley","last_name":"Tran","name":"Wesley Tran","linkedin_url":"http://www.linkedin.com/in/wesley-tran-5a9c3e74","title":"Technical Writer II","contact_stage_id":"6095a710bd01d100a506d4af","owner_id":null,"creator_id":"60affe7d6e270a00f5db6fe4","person_id":"66f0b509f10e970001a0b1b0","email_needs_tickling":false,"organization_name":"Apollo.io","source":"search","original_source":"email_import","organization_id":"5e66b6381e05b4008c8331b8","headline":"Technical writer","photo_url":null,"present_raw_address":"Portland, Oregon, United States","linkedin_uid":null,"extrapolated_email_confidence":null,"salesforce_id":null,"salesforce_lead_id":null,"salesforce_contact_id":null,"salesforce_account_id":null,"crm_owner_id":null,"created_at":"2024-03-25T16:30:07.555Z","emailer_campaign_ids":["66a97236a8759801b5417678","6567758e12b81a0264ab0bb1","67be333b81ca47000d1cfb9f","684b215edf80730019db612c"],"direct_dial_status":"enrichment_failed","direct_dial_enrichment_failed_at":"2025-02-27T15:16:57.036+00:00","city":"Portland","country":"United States","state":"Oregon","email_status":"verified","email_source":"crm","account_id":"6518c6184f20350001a0b9c0","last_activity_date":"2025-06-23T19:54:36.000+00:00","hubspot_vid":null,"hubspot_company_id":null,"crm_id":null,"sanitized_phone":"+14155550181","merged_crm_ids":null,"updated_at":"2025-06-23T19:54:36.183Z","queued_for_crm_push":false,"suggested_from_rule_engine_config_id":null,"email_unsubscribed":null,"person_deleted":null,"call_opted_out":null,"label_ids":["66a96f0cb2ef9801b486f3fd"],"has_pending_email_arcgate_request":false,"has_email_arcgate_request":false,"existence_level":"full","email":"dwesley.t@example.com","email_from_customer":null,"typed_custom_fields":{},"custom_field_errors":{},"crm_record_url":null,"email_status_unavailable_reason":null,"email_true_status":"Verified","updated_email_true_status":true,"source_display_name":"Requested from Apollo","twitter_url":null,"facebook_url":null,"contact_campaign_statuses":[{"id":"66a977e82a86cb000139ceff","emailer_campaign_id":"66a97236a8759801b5417678","send_email_from_user_id":"66a3d80d4238fe02d2baaaaf","inactive_reason":"replied","status":"finished","added_at":"2024-07-30T23:31:51.991+00:00","added_by_user_id":"66a3d80d4238fe02d2baaaaf","finished_at":"2024-10-08T16:51:24.185+00:00","paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"priya.nadkarni@apollomail.io","send_email_from_email_account_id":"66a423655825e8019ae89db6","manually_set_unpause":null,"failure_reason":null,"current_step_id":"66a97236a8759801b541767d","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":3},{"id":"6708721db13a0a000190999c","emailer_campaign_id":"6567758e12b81a0264ab0bb1","send_email_from_user_id":"66a3d80d4238fe02d2baaaaf","inactive_reason":"User deleted","status":"failed","added_at":"2024-10-11T00:32:29.857+00:00","added_by_user_id":"60affe7d6e270a00f5db6fe4","finished_at":null,"paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"priya.nadkarni@apollomail.io","send_email_from_email_account_id":"66a423655825e8019ae89db6","manually_set_unpause":null,"failure_reason":"user_deleted","current_step_id":null,"in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":null},{"id":"680bd68fbfaec40015b9b32b","emailer_campaign_id":"67be333b81ca47000d1cfb9f","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":null,"status":"active","added_at":"2025-04-25T18:38:07.090+00:00","added_by_user_id":"66302798d03b9601c7934ebf","finished_at":null,"paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":null,"current_step_id":"67be333b81ca47000d1cfba0","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":2},{"id":"684b21d0de0df60015d2218d","emailer_campaign_id":"684b215edf80730019db612c","send_email_from_user_id":"66302798d03b9601c7934ebf","inactive_reason":"Completed last step","status":"finished","added_at":"2025-06-12T18:52:00.914+00:00","added_by_user_id":"66302798d03b9601c7934ebf","finished_at":"2025-06-12T21:34:16.705+00:00","paused_at":null,"auto_unpause_at":null,"send_email_from_email_address":"test.marcus.hale@apollomail.io","send_email_from_email_account_id":"6633baaece5fbd01c791d7ca","manually_set_unpause":null,"failure_reason":"contact_stage_safeguard","current_step_id":"684b216ec95a4f001d968d19","in_response_to_emailer_message_id":null,"cc_emails":null,"bcc_emails":null,"to_emails":null,"current_step_position":1}],"contact_emails":[{"email_md5":"210b056db397b0a452dbd967d19f9cb5","email_sha256":"a6ec970636a0a3c3fda95094cc2bb23a580ed900d7e96a517ad7694f657d8012","email_status":"verified","extrapolated_email_confidence":null,"position":0,"email":"wesley.t@example.com","free_domain":false,"source":"Apollo","third_party_vendor_name":null,"vendor_validation_statuses":[],"email_needs_tickling":false,"email_true_status":"Verified","email_status_unavailable_reason":null}],"time_zone":"America/Los_Angeles","intent_strength":null,"show_intent":false,"phone_numbers":[{"raw_number":"+1 415-555-0181","sanitized_number":"+14155550181","type":"work_hq","position":0,"status":"no_status","dnc_status":null,"dnc_other_info":{},"dialer_flags":null,"source_name":"Apollo","vendor_validation_statuses":[],"third_party_vendor_name":null}],"account_phone_note":null,"free_domain":false,"email_domain_catchall":false}}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"Need Master API Key":{"value":"{\n \"error\": \"api/v1/usage_stats/api_usage_stats is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}","summary":"Need Master API Key"}}}}}},"parameters":[{"name":"logged","in":"query","required":false,"description":"Set to `true` if you want to create an individual record for the phone call in Apollo.","schema":{"type":"boolean","default":""}},{"name":"user_id[]","in":"query","required":false,"description":"Designate the caller in your team's Apollo account.

Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.

Example: `67e33d527de088000daa60c4`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"contact_id","in":"query","required":false,"description":"Designate the contact that was called.

Use the Search for Contacts endpoint to retrieve IDs for all of the contacts within your Apollo account.

Example: `66e34b81740c50074e3d1bd4`","schema":{"type":"string","default":""}},{"name":"account_id","in":"query","required":false,"description":"Associate the call with an account.

Use the Search for Accounts endpoint to retrieve IDs for all of the accounts within your Apollo account.

Example: `66e9abf95ac32901b20d1a0d`","schema":{"type":"string","default":""}},{"name":"to_number","in":"query","required":false,"description":"The phone number that you dialed.

Example: `5555550164`","schema":{"type":"string","default":""}},{"name":"from_number","in":"query","required":false,"description":"The phone number that dialed you.

Example: `5555550164`","schema":{"type":"string","default":""}},{"name":"status","in":"query","required":false,"description":"The status of the phone call. Possible values include: ","schema":{"type":"string","default":""}},{"name":"start_time","in":"query","required":false,"description":"The time when the call started.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a start time that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifiying in hours and minutes how much you want to offset GMT.

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`","schema":{"type":"string","format":"date-time","default":""}},{"name":"end_time","in":"query","required":false,"description":"The time when the call ended.

Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a end time that falls on a different day than you intended.

The value you enter can either adhere to GMT, or you can adjust the time manually by specifiying in hours and minutes how much you want to offset GMT.

Example: `2025-05-15T08:10:30Z`; `2025-05-25T10:15:30+05:00Z`","schema":{"type":"string","format":"date-time","default":""}},{"name":"duration","in":"query","required":false,"description":"The duration of the call in seconds. Do not enter minutes.

Examples: `120`; `205`","schema":{"type":"integer","default":""}},{"name":"phone_call_purpose_id","in":"query","required":false,"description":"Assign a call purpose to the record.

Call purposes are unique to your team's Apollo account. When you use the Purpose search filter for calls in the Apollo product, you can find the corresponding call purpose ID in the URL.

Examples: `6095a710bd01d100a506d4cd`","schema":{"type":"string","default":""}},{"name":"phone_call_outcome_id","in":"query","required":false,"description":"Assign a call outcome to the record.

Call outcomes are unique to your team's Apollo account. When you use the Disposition search filter for calls in the Apollo product, you can find the corresponding call outcome ID in the URL.

Examples: `6095a710bd01d100a506d4c5`","schema":{"type":"string","default":""}},{"name":"note","in":"query","required":false,"description":"Add a note to the call record.

Example: `This lead is interested in learning more about our new product line.`","schema":{"type":"string","default":""}},{"in":"path","name":"id","description":"The Apollo ID for the call record that you want to update.

To find call record IDs, call the Search for Calls endpoint and identify the `id` value for the call record.

Example: `6859b0dd828b270021e69648`","schema":{"type":"string"},"required":true}]}},"/news_articles/search":{"post":{"summary":"News Articles Search","description":"This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nNews includes articles related to companies in Apollo.

Use the News Articles Search endpoint to find news articles related to specific companies. Several filters are available to help narrow your search.","tags":["Search"],"operationId":"news_articles_search","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"pagination":{"page":1,"per_page":25,"total_entries":10,"total_pages":1},"news_articles":[{"id":"6815925ac310740011aba570","url":"https://techintelpro.com/news/apolloio-appoints-marcio-arnecke-as-cmo-and-adam-carr-as-cro-to-accelerate-ai-powered-go-to-market-innovation","domain":"techintelpro.com","title":"Apollo.io Appoints Marcio Arnecke as CMO and Adam Carr as CRO to Accelerate AI-Powered Go-to-Market Innovation","snippet":"Apollo.io, a leading AI-powered go-to-market sales platform, today announced the appointments of Marcio Arnecke as Chief Marketing Officer (CMO) and Adam Carr as Chief Revenue Officer (CRO).","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2025-05-02T00:00:00.000+00:00","event_categories":["hires"]},{"id":"681592d92d7b13001977c6df","url":"https://techintelpro.com/news/apolloio-appoints-marcio-arnecke-as-cmo-and-adam-carr-as-cro-to-accelerate-ai-powered-go-to-market-innovation","domain":"techintelpro.com","title":"Apollo.io Appoints Marcio Arnecke as CMO and Adam Carr as CRO to Accelerate AI-Powered Go-to-Market Innovation","snippet":"Apollo.io, a leading AI-powered go-to-market sales platform, today announced the appointments of Marcio Arnecke as Chief Marketing Officer (CMO) and Adam Carr as Chief Revenue Officer (CRO).","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2025-05-02T00:00:00.000+00:00","event_categories":["hires"]},{"id":"668961e815876f040da3b685","url":"https://www.prnewswire.com/news-releases/meet-the-new-faces-driving-apollos-gtm-evolution-matt-curl-as-coo-and-rich-bessel-as-svp-of-design-302187696.html","domain":"prnewswire.com","title":"Meet the New Faces Driving Apollo's GTM Evolution: Matt Curl as COO and Rich Bessel as SVP of Design","snippet":"SAN FRANCISCO, July 2, 2024 /PRNewswire/ - Apollo.io, a leading go-to-market (GTM) solution for sales and marketing teams, has appointed two new executives to its leadership team: Matt Curl as Chief Operating Officer (COO) and Rich Bessel as SVP of Design.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2024-07-02T12:00:00.000+00:00","event_categories":["hires"]},{"id":"668962016fbe79040e1c0490","url":"https://www.prnewswire.com/news-releases/meet-the-new-faces-driving-apollos-gtm-evolution-matt-curl-as-coo-and-rich-bessel-as-svp-of-design-302187696.html","domain":"prnewswire.com","title":"Meet the New Faces Driving Apollo's GTM Evolution: Matt Curl as COO and Rich Bessel as SVP of Design","snippet":"SAN FRANCISCO, July 2, 2024 /PRNewswire/ - Apollo.io, a leading go-to-market (GTM) solution for sales and marketing teams, has appointed two new executives to its leadership team: Matt Curl as Chief Operating Officer (COO) and Rich Bessel as SVP of Design.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2024-07-02T12:00:00.000+00:00","event_categories":["hires"]},{"id":"64c0037589653e00a34746c7","url":"https://www.prnewswire.com/news-releases/leandra-fishman-joins-apolloio-as-chief-revenue-officer-fueling-revenue-growth-and-product-innovation-301884666.html","domain":"prnewswire.com","title":"Leandra Fishman joins Apollo.io as Chief Revenue officer, fueling Revenue growth and Product innovation","snippet":"Apollo.io, the leading go-to-market sales platform, today announced the appointment of Leandra Fishman to its executive team as the company's first Chief Revenue Officer (CRO).","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2023-07-25T11:00:00.000+00:00","event_categories":["hires"]},{"id":"63e68163e3288200a36b69c8","url":"https://finance.yahoo.com/news/apollo-io-announces-shek-viswanathan-152200939.html","domain":"yahoo.com","title":"Apollo.io Announces Shek Viswanathan as Chief Product Officer Amidst Record January Revenue Numbers and Expanded Product Vision","snippet":"Today, Apollo.io, the world's leading B2B sales intelligence and engagement platform, announces the appointment of Shek Viswanathan as their Chief Product Officer.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2023-02-08T15:22:00.000+00:00","event_categories":["hires"]},{"id":"61815864ad796300e07c74f7","url":"https://www.finsmes.com/2021/11/apollo-io-raises-32m-in-series-b-funding.html","domain":"finsmes.com","title":"Apollo.io Raises $32M in Series B Funding","snippet":"In conjunction with the funding, Sri Pangulur, partner at Tribe Capital, joined Apollo.io’s board.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2021-11-01T21:44:42.000+00:00","event_categories":["hires"]},{"id":"6151bee43115c900a4ec4e94","url":"https://techrseries.com/hrtechnology/apollo-io-appoints-lisa-feher-as-chief-people-officer/","domain":"techrseries.com","title":"Apollo.IO Appoints Lisa Feher as Chief People Officer","snippet":"Apollo.io, a lead intelligence and sales engagement platform, has announced that Lisa Feher has joined the company as its Chief People Officer.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2021-09-17T00:00:00.000+00:00","event_categories":["hires"]},{"id":"61fdec31979c2300a50b5619","url":"https://blog.apollo.io/blog/apollo-announces-appointment-of-santosh-sharan-as-president-and-coo","domain":"apollo.io","title":"Apollo Announces Appointment of Santosh Sharan as President and COO β€” Apollo Blog","snippet":"SAN FRANCISCO, April 15, 2021 /PRNewswire/ -- Apollo, a leading data intelligence and sales engagement platform, announces that Santosh Sharan has joined the company as President and Chief Operating Officer (COO).","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2021-04-15T00:00:00.000+00:00","event_categories":["hires"]},{"id":"61413082e89bde40f424c677","url":"https://nexusvp.com/press-releases/apollo-io-brings-on-clearslide-co-founder-jim-benton-as-ceo/","domain":"nexusvp.com","title":"Apollo.io Brings on ClearSlide Co-Founder Jim Benton as CEO – Nexus Venture Partners","snippet":"(BUSINESS WIRE)–Apollo.io, the most intelligent data-first engagement platform for sales and marketing teams, today announced that it has hired Jim Benton as CEO.","organization_ids":["5e66b6381e05b4008c8331b8"],"published_at":"2019-06-06T16:00:44.000+00:00","event_categories":["hires"]}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"examples":{"Check API Key":{"value":"Invalid access credentials.","summary":"Check API Key"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"Add Organization IDs":{"value":{"error":"organization_ids is required"},"summary":"Add Organization IDs"}}}}}},"parameters":[{"name":"organization_ids[]","in":"query","required":true,"description":"The Apollo IDs for the companies you want to include in your search results. Each company in the Apollo database is assigned a unique ID.

To find IDs, call the Organization Search endpoint and identify the values for `organization_id`.

Example: `5e66b6381e05b4008c8331b8`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"categories[]","in":"query","required":false,"description":"Filter your search to include only certain categories or sub-categories of news. Use the News search filter for companies within Apollo to uncover all possible categories and sub-categories.

Examples: `hires`; `investment`; `contract`","schema":{"type":"array","default":"","items":{"type":"string"}}},{"name":"published_at[min]","in":"query","required":false,"description":"Set the lower bound of the date range you want to search.

Use this parameter in combination with the `published_at[max]` parameter. This date should fall before the `published_at[max]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-02-15`","schema":{"type":"string","format":"date","default":""}},{"name":"published_at[max]","in":"query","required":false,"description":"Set the upper bound of the date range you want to search.

Use this parameter in combination with the `published_at[min]` parameter. This date should fall after the `published_at[min]` date.

The date should be formatted as `YYYY-MM-DD`.

Example: `2025-05-15`","schema":{"type":"string","format":"date","default":""}},{"name":"page","in":"query","required":false,"description":"The page number of the Apollo data that you want to retrieve.

Use this parameter in combination with the `per_page` parameter to make search results for navigable and improve the performance of the endpoint.

Example: `4`","schema":{"type":"integer","default":""}},{"name":"per_page","in":"query","required":false,"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.

Use the `page` parameter to search the different pages of data.

Example: `10`","schema":{"type":"integer","default":""}}]}},"/emailer_campaigns/{sequence_id}/approve":{"post":{"summary":"Activate a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Activate a Sequence endpoint to start an inactive sequence. Once activated, the sequence begins sending emails to its contacts on the configured schedule. The sequence must have at least one step configured before it can be activated.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"approve-sequence","parameters":[{"name":"sequence_id","in":"path","description":"The Apollo ID for the sequence that you want to activate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":{"emailer_campaign":{"id":"66e9e215ece19801b219997f","unique_scheduled":5,"active":true},"emailer_steps":[{"id":"66e9e215ece19801b2199980","emailer_campaign_id":"66e9e215ece19801b219997f","position":1,"wait_time":1,"type":"auto_email","note":null}]}}},"schema":{"type":"object","properties":{"emailer_campaign":{"type":"object","properties":{"id":{"type":"string"},"unique_scheduled":{"type":"integer"},"active":{"type":"boolean"}}},"emailer_steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"emailer_campaign_id":{"type":"string"},"position":{"type":"integer"},"wait_time":{"type":"integer"},"type":{"type":"string"},"note":{"type":"string","nullable":true}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/emailer_campaigns/approve is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/emailer_campaigns/approve is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Already active":{"value":"{\"error\": \"The sequence is already active.\"}"},"No steps":{"value":"{\"error\": \"Please make sure you have added at least 1 step before turning on the sequence.\"}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/approve is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/approve is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}}},"/emailer_campaigns/{sequence_id}/abort":{"post":{"summary":"Deactivate a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Deactivate a Sequence endpoint to stop an active sequence. Once deactivated, the sequence pauses all contacts and stops sending emails.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"abort-sequence","parameters":[{"name":"sequence_id","in":"path","description":"The Apollo ID for the sequence that you want to deactivate.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":{"emailer_campaign":{"id":"66e9e215ece19801b219997f","unique_scheduled":5,"active":false},"emailer_steps":[{"id":"66e9e215ece19801b2199980","emailer_campaign_id":"66e9e215ece19801b219997f","position":1,"wait_time":1,"type":"auto_email","note":null}]}}},"schema":{"type":"object","properties":{"emailer_campaign":{"type":"object","properties":{"id":{"type":"string"},"unique_scheduled":{"type":"integer"},"active":{"type":"boolean"}}},"emailer_steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"emailer_campaign_id":{"type":"string"},"position":{"type":"integer"},"wait_time":{"type":"integer"},"type":{"type":"string"},"note":{"type":"string","nullable":true}}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/emailer_campaigns/abort is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/emailer_campaigns/abort is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Already inactive":{"value":"{\"error\": \"The sequence is already inactive.\"}"}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/abort is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/abort is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}}},"/emailer_campaigns/{sequence_id}/archive":{"post":{"summary":"Archive a Sequence","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nSequences are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.

Use the Archive a Sequence endpoint to archive a sequence. Archiving a sequence marks it as inactive and finishes all contacts currently in the sequence. You must be the owner of the sequence or have full access sharing permissions to archive it.

This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out Create an API Key to learn how to create a master key.","tags":["Sequences"],"operationId":"archive-sequence","parameters":[{"name":"sequence_id","in":"path","description":"The Apollo ID for the sequence that you want to archive.

To find sequence IDs, call the Search for Sequences endpoint and identify the id value for the sequence.

Example: 66e9e215ece19801b219997f","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK":{"value":{"emailer_campaign":{"id":"66e9e215ece19801b219997f","active":false,"archived":true,"deleted":true}}}},"schema":{"type":"object","properties":{"emailer_campaign":{"type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"},"archived":{"type":"boolean"},"deleted":{"type":"boolean"}}}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Need master API key":{"value":"{\n \"error\": \"api/v1/emailer_campaigns/archive is not accessible with this api_key\",\n \"error_code\": \"API_INACCESSIBLE\"\n}"}},"schema":{"title":"Need master API key","type":"object","properties":{"error":{"type":"string","example":"api/v1/emailer_campaigns/archive is not accessible with this api_key"},"error_code":{"type":"string","example":"API_INACCESSIBLE"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":"{\n \"message\": \"The maximum number of api calls allowed for api/v1/emailer_campaigns/archive is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The maximum number of api calls allowed for api/v1/emailer_campaigns/archive is 600 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}}}}}}}},"/notes":{"get":{"summary":"Get a List of Notes","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nNotes on Apollo let you keep track of info directly on prospect profiles.

The Get a List of Notes endpoint retrieves notes associated with a specific contact, account, opportunity, calendar event, or conversation in your Apollo account. You must provide at least one relation parameter (account_id, contact_id, contact_ids, opportunity_id, calendar_event_id, conversation_id, or conversation_ids). Use this endpoint to fetch notes with sorting and pagination support.","tags":["Miscellaneous"],"operationId":"get-a-list-of-notes","parameters":[{"name":"contact_id","in":"query","description":"The ID of the contact whose notes you want to retrieve.

Example: `60a5c0b8e4b0c7001c4f1234`","schema":{"type":"string"}},{"name":"account_id","in":"query","description":"The ID of the account whose notes you want to retrieve.

Example: `60a5c0b8e4b0c7001c4f5678`","schema":{"type":"string"}},{"name":"opportunity_id","in":"query","description":"The ID of the opportunity whose notes you want to retrieve.

Example: `60a5c0b8e4b0c7001c4f9012`","schema":{"type":"string"}},{"name":"calendar_event_id","in":"query","description":"The ID of the calendar event whose notes you want to retrieve.

Example: `60a5c0b8e4b0c7001c4f3456`","schema":{"type":"string"}},{"name":"conversation_id","in":"query","description":"The ID of the conversation whose notes you want to retrieve.

Example: `60a5c0b8e4b0c7001c4f7890`","schema":{"type":"string"}},{"name":"conversation_ids","in":"query","description":"An array of conversation IDs to filter notes by multiple conversations.","schema":{"type":"array","items":{"type":"string"}}},{"name":"contact_ids","in":"query","description":"An array of contact IDs to filter notes by multiple contacts.","schema":{"type":"array","items":{"type":"string"}}},{"name":"start_date","in":"query","description":"Filter notes created on or after this date. Must be a valid date string.

Example: `2024-01-01`","schema":{"type":"string"}},{"name":"sort_by_field","in":"query","description":"The field to sort results by. Defaults to `created_at`.","schema":{"type":"string","enum":["created_at","updated_at"],"default":"created_at"}},{"name":"sort_direction","in":"query","description":"The direction to sort results. Defaults to `desc`.","schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"skip","in":"query","description":"The number of notes to skip for pagination. Must be a non-negative integer. Defaults to `0`.","schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of notes to return per request. Defaults to `25`. Maximum value is `100`.","schema":{"type":"integer","default":25,"maximum":100}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"notes":[{"id":"60a5c0b8e4b0c7001c4fabcd","user_id":"60a5c0b8e4b0c7001c4f0001","content":"Had a productive call with the client. They are interested in the enterprise plan.","updated_at":"2024-06-15T14:30:00.000Z","created_at":"2024-06-15T14:30:00.000Z","contact_id":"60a5c0b8e4b0c7001c4f1234","conversation_id":null,"account_id":"60a5c0b8e4b0c7001c4f5678","pinned_to_top":false,"system":false,"opportunity_id":null,"account_ids":[],"contact_ids":["60a5c0b8e4b0c7001c4f1234"],"opportunity_ids":[],"calendar_event_ids":[],"conversation_ids":[],"is_org_chart_note":false,"crm_notes":[]}]}}},"schema":{"type":"object","properties":{"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the note.","example":"60a5c0b8e4b0c7001c4fabcd"},"user_id":{"type":"string","description":"The ID of the user who created the note.","example":"60a5c0b8e4b0c7001c4f0001"},"content":{"type":"string","description":"The content of the note.","example":"Had a productive call with the client."},"updated_at":{"type":"string","description":"The timestamp when the note was last updated.","example":"2024-06-15T14:30:00.000Z"},"created_at":{"type":"string","description":"The timestamp when the note was created.","example":"2024-06-15T14:30:00.000Z"},"contact_id":{"type":"string","nullable":true,"description":"The ID of the associated contact.","example":"60a5c0b8e4b0c7001c4f1234"},"conversation_id":{"type":"string","nullable":true,"description":"The ID of the associated conversation.","example":null},"account_id":{"type":"string","nullable":true,"description":"The ID of the associated account.","example":"60a5c0b8e4b0c7001c4f5678"},"pinned_to_top":{"type":"boolean","description":"Whether the note is pinned to the top.","example":false},"system":{"type":"boolean","description":"Whether this is a system-generated note.","example":false},"opportunity_id":{"type":"string","nullable":true,"description":"The ID of the associated opportunity.","example":null},"account_ids":{"type":"array","items":{"type":"string"},"description":"Array of associated account IDs."},"contact_ids":{"type":"array","items":{"type":"string"},"description":"Array of associated contact IDs."},"opportunity_ids":{"type":"array","items":{"type":"string"},"description":"Array of associated opportunity IDs."},"calendar_event_ids":{"type":"array","items":{"type":"string"},"description":"Array of associated calendar event IDs."},"conversation_ids":{"type":"array","items":{"type":"string"},"description":"Array of associated conversation IDs."},"is_org_chart_note":{"type":"boolean","description":"Whether this note is an org chart note.","example":false},"crm_notes":{"type":"array","description":"Array of associated CRM note records."}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Missing required filter":{"value":{"error":"At least one argument is required"}},"Invalid sort direction":{"value":{"error":"sort_direction must be \"asc\" or \"desc\""}},"Invalid sort field":{"value":{"error":"sort_by_field must be one of: created_at, updated_at"}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"At least one argument is required"}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}}},"deprecated":false}},"/reports/sync_report":{"post":{"summary":"Query Analytics Report","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Query Analytics Report endpoint to programmatically query Apollo analytics and retrieve aggregated sales activity data for your team.

This endpoint accepts a flexible payload specifying which metrics to measure, how to group and filter results, and which date range to apply β€” returning the same data that powers Apollo's built-in Analytics dashboards.

Three query modes are supported: flat totals (no group_by), grouped by one dimension such as user or sequence, and pivot cross-tab (one group_by dimension as rows + one pivot_group_by dimension as columns). Each array supports a maximum of one entry.

\nAuthentication: Requires an Apollo API key with access to the api/v1/reports/sync_report API. When creating or editing an API key in Apollo Settings, open the APIs tab and select api/v1/reports/sync_report from the list. Check out Create an API Key for detailed instructions.

Tip: The easiest way to discover valid metric and group_by combinations is to build a report interactively at Apollo Analytics β†’ Start from scratch, then replicate that configuration in your API request.","tags":["Analytics"],"operationId":"sync-report","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["metrics","group_by","sorts","filters","group_by_totals_selected","pivot_group_by_totals_selected","date_ranges"],"properties":{"metrics":{"type":"array","description":"The metrics to query. Each object specifies which metric to measure and which date and user columns the engine should use for that metric. The smart_datetime_reference and smart_user_id_reference values are metric-specific β€” using the wrong values will return no data. Refer to the Metrics and Dimensions Reference for valid metric names and the correct reference fields for each.

Pass an empty array [] to return a response with no metric columns.","items":{"type":"object","required":["value","smart_datetime_reference","smart_user_id_reference"],"properties":{"value":{"type":"string","description":"The metric identifier. For built-in metrics, use the metric name (e.g. num_emails_sent). For team-defined custom metrics, use the format custom_metric_{id} where {id} is the custom metric's id."},"smart_datetime_reference":{"type":"string","description":"The date column name to use for this metric's time axis. Many metrics use smart_datetime_range. Check the Metrics Reference for the correct value for each metric.

Example: smart_datetime_range"},"smart_user_id_reference":{"type":"string","description":"The user column name to use for this metric's user axis. Many metrics use smart_user_id. Check the Metrics Reference for the correct value for each metric.

Example: smart_user_id"},"display_name":{"type":"string","description":"Optional label override for this metric's column in the response."}}}},"group_by":{"type":"array","maxItems":1,"description":"The dimension to group results by (row dimension). Pass one object to break results down by that dimension. Pass an empty array [] for flat totals with no grouping.

Only one entry is supported. Refer to the Metrics and Dimensions Reference for valid dimension names.","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The dimension name.

Example: smart_user_id"},"limit":{"type":"integer","description":"Maximum number of dimension values to return."}}}},"pivot_group_by":{"type":"array","maxItems":1,"description":"The dimension to pivot on (column dimension). Used together with group_by to produce a two-dimensional cross-tab table: group_by defines the row dimension and pivot_group_by defines the column dimension. Pass an empty array [] for non-pivot queries.

Only one entry is supported.","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The dimension name to pivot on.

Example: emailer_campaign_id"},"limit":{"type":"integer","description":"Maximum number of pivot column values to return."}}}},"sorts":{"type":"array","description":"Sort order for the result rows. Only the first entry is applied. Pass an empty array [] to use the default order.

Sorting is supported by metric value β€” provide the metric field with the same structure as an entry in the metrics array. The asc field controls direction (true = ascending, false = descending).

Sorting by dimension value (e.g. alphabetically by user name) is not supported via the API.","items":{"type":"object","required":["asc"],"properties":{"asc":{"type":"boolean","description":"Sort ascending (true) or descending (false)."},"metric":{"type":"object","description":"Sort by a metric column. Provide the same structure as a metric entry in the metrics array.","properties":{"value":{"type":"string"},"smart_datetime_reference":{"type":"string"},"smart_user_id_reference":{"type":"string"}}}}}},"filters":{"type":"object","description":"Key/value filter map to narrow the result set. Pass an empty object {} for no filters. Common filter keys are documented in the properties below; additional dimension-based filters may also be passed using the same key names as group_by[].name values. Refer to the Metrics and Dimensions Reference for a complete list.","properties":{"smart_user_id":{"type":"array","description":"Filter to specific team member IDs. Use \"current\" for the authenticated user.

Example: [\"current\"]","items":{"type":"string"}},"smart_subteam_id":{"type":"array","description":"Filter to specific sub-team IDs.","items":{"type":"string"}},"emailer_campaign_ids":{"type":"array","description":"Filter to specific sequence IDs.","items":{"type":"string"}},"contact_stage_ids":{"type":"array","description":"Filter to specific contact stage IDs.","items":{"type":"string"}},"account_stage_ids":{"type":"array","description":"Filter to specific account stage IDs.","items":{"type":"string"}},"opportunity_stage_ids":{"type":"array","description":"Filter to specific opportunity stage IDs.","items":{"type":"string"}},"email_account_ids":{"type":"array","description":"Filter to specific sender mailbox IDs.","items":{"type":"string"}},"smart_datetime_range":{"type":"object","description":"Required when date_ranges[].modality is custom_range. Specifies the exact date window as ISO 8601 date strings.","required":["min","max"],"properties":{"min":{"type":"string","description":"Start date (inclusive). Format: YYYY-MM-DD.

Example: 2024-01-01"},"max":{"type":"string","description":"End date (inclusive). Format: YYYY-MM-DD.

Example: 2024-03-31"}}}},"additionalProperties":true},"group_by_totals_selected":{"type":"boolean","description":"When true, the response includes an aggregated totals row in addition to the per-dimension-value rows."},"pivot_group_by_totals_selected":{"type":"boolean","description":"When true, the pivot response includes an aggregated totals column in addition to the per-pivot-value columns."},"date_ranges":{"type":"array","description":"The time window for the query. Provide one object with a modality preset. For a custom date range, set modality to custom_range and add a smart_datetime_range key in filters with {\"min\": \"YYYY-MM-DD\", \"max\": \"YYYY-MM-DD\"}.","items":{"type":"object","required":["modality"],"properties":{"modality":{"type":"string","description":"Date range preset. Valid values: today, yesterday, current_week, current_month, current_quarter, current_year, last_7_days, last_2_weeks, last_30_days, last_3_months, last_6_months, last_12_months, last_4_quarters, last_2_years, previous_week, previous_month, previous_quarter, previous_year, all_time, custom_range (requires smart_datetime_range in filters)."}}},"maxItems":1},"skip_group_by_values":{"type":"array","maxItems":500,"description":"Exclude specific dimension values from the result rows. Values must match the raw key field returned in bucket responses for the active group_by dimension (e.g. a contact stage ID string, a user ID string, or a date string for datetime dimensions). Maximum 500 entries.","items":{"type":"string"}},"min_ratio_denominator":{"type":"integer","default":0,"description":"Minimum denominator threshold for ratio metrics. Rows where the denominator falls below this value are excluded from ratio calculations."}}},"examples":{"Flat totals β€” email performance":{"value":{"metrics":[{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"num_emails_opened","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"percent_emails_opened_tracked","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[],"pivot_group_by":[],"sorts":[],"filters":{},"group_by_totals_selected":false,"pivot_group_by_totals_selected":false,"date_ranges":[{"modality":"last_30_days"}]}},"Grouped β€” email activity by user":{"value":{"metrics":[{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"num_emails_replied","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"percent_emails_replied","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[{"name":"smart_user_id"}],"pivot_group_by":[],"sorts":[{"metric":{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},"asc":false}],"filters":{},"group_by_totals_selected":true,"pivot_group_by_totals_selected":false,"date_ranges":[{"modality":"current_month"}]}},"Grouped β€” email volume by month":{"value":{"metrics":[{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[{"name":"smart_datetime_month"}],"pivot_group_by":[],"sorts":[],"filters":{},"group_by_totals_selected":false,"pivot_group_by_totals_selected":false,"date_ranges":[{"modality":"last_12_months"}]}},"Pivot β€” emails sent by user x contact stage":{"value":{"metrics":[{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[{"name":"smart_user_id"}],"pivot_group_by":[{"name":"contact_stage_id"}],"sorts":[],"filters":{},"group_by_totals_selected":true,"pivot_group_by_totals_selected":true,"date_ranges":[{"modality":"last_30_days"}]}},"Sorted β€” top 5 reps by reply rate":{"value":{"metrics":[{"value":"num_emails_sent","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"num_emails_replied","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"percent_emails_replied","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[{"name":"smart_user_id","limit":5}],"pivot_group_by":[],"sorts":[{"metric":{"value":"percent_emails_replied","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},"asc":false}],"filters":{},"group_by_totals_selected":false,"pivot_group_by_totals_selected":false,"date_ranges":[{"modality":"current_quarter"}]}},"Custom date range β€” call activity for Q1":{"value":{"metrics":[{"value":"num_phone_calls","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"num_phone_calls_connect","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"},{"value":"percent_phone_calls_connect","smart_datetime_reference":"smart_datetime_range","smart_user_id_reference":"smart_user_id"}],"group_by":[{"name":"smart_user_id"}],"pivot_group_by":[],"sorts":[],"filters":{"smart_datetime_range":{"min":"2024-01-01","max":"2024-03-31"}},"group_by_totals_selected":true,"pivot_group_by_totals_selected":false,"date_ranges":[{"modality":"custom_range"}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","description":"The query result. Contains four sub-keys depending on query mode and flags. See response examples for each shape.","properties":{"table_response":{"type":"object","description":"Main aggregated data. Shape varies by query mode: a flat key/value object when group_by is empty (metric name β†’ value); a bucketed object { \"dimension\": { \"buckets\": [...] } } for grouped queries; a nested bucketed object for pivot queries where the outer key is the pivot_group_by dimension and each outer bucket contains a nested group_by dimension with its own buckets.","additionalProperties":true},"group_by_total_response":{"type":"object","description":"Aggregated totals per group_by dimension value, without pivot breakdown. Same bucketed structure as table_response. Populated when group_by_totals_selected is true; otherwise {}.","additionalProperties":true},"pivot_group_by_total_response":{"type":"object","description":"Aggregated totals per pivot_group_by dimension value, without group_by breakdown. Populated when pivot_group_by_totals_selected is true; otherwise {}.","additionalProperties":true}}},"incompatible_filters":{"type":"object","description":"A map of filter keys that were incompatible with one or more requested metrics and were silently ignored. Keys are filter names; values are arrays of affected metric names. Inspect this field when results appear incomplete.","additionalProperties":{"type":"array","items":{"type":"string"}}},"goals":{"type":"array","description":"Goal attainment data. This field is unrelated to data querying β€” you can ignore it.","items":{"type":"object"}}}},"examples":{"Flat totals β€” email performance":{"value":{"response":{"table_response":{"num_emails_sent":1240,"num_emails_opened":410,"percent_emails_opened_tracked":0.331,"percent_emails_opened_tracked_denominator":1240},"group_by_total_response":{},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}},"Grouped β€” email activity by user":{"value":{"response":{"table_response":{"smart_user_id":{"buckets":[{"key":"60a5c0b8e4b0c7001c4f1234","readable_key":"Alice Smith","num_emails_sent":320,"num_emails_replied":48,"percent_emails_replied":0.15,"percent_emails_replied_denominator":320},{"key":"60a5c0b8e4b0c7001c4f5678","readable_key":"Bob Jones","num_emails_sent":280,"num_emails_replied":56,"percent_emails_replied":0.2,"percent_emails_replied_denominator":280}]}},"group_by_total_response":{"smart_user_id":{"buckets":[{"key":"total","readable_key":"Total","num_emails_sent":600,"num_emails_replied":104,"percent_emails_replied":0.173,"percent_emails_replied_denominator":600}]}},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}},"Grouped β€” email volume by month":{"value":{"response":{"table_response":{"smart_datetime_month":{"buckets":[{"key":"2024-01-01","readable_key":"Jan 2024","num_emails_sent":840},{"key":"2024-02-01","readable_key":"Feb 2024","num_emails_sent":920},{"key":"2024-03-01","readable_key":"Mar 2024","num_emails_sent":1105},{"key":"2024-04-01","readable_key":"Apr 2024","num_emails_sent":980}]}},"group_by_total_response":{},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}},"Pivot β€” emails sent by user x contact stage":{"value":{"response":{"table_response":{"contact_stage_id":{"buckets":[{"key":"5f9a1b2c3d4e5f6a7b8c9d0e","readable_key":"New","smart_user_id":{"buckets":[{"key":"60a5c0b8e4b0c7001c4f1234","readable_key":"Alice Smith","num_emails_sent":120},{"key":"60a5c0b8e4b0c7001c4f5678","readable_key":"Bob Jones","num_emails_sent":95}]}},{"key":"5f9a1b2c3d4e5f6a7b8c9d1f","readable_key":"Contacted","smart_user_id":{"buckets":[{"key":"60a5c0b8e4b0c7001c4f1234","readable_key":"Alice Smith","num_emails_sent":85},{"key":"60a5c0b8e4b0c7001c4f5678","readable_key":"Bob Jones","num_emails_sent":110}]}}]}},"group_by_total_response":{},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}},"Sorted β€” top 5 reps by reply rate":{"value":{"response":{"table_response":{"smart_user_id":{"buckets":[{"key":"60a5c0b8e4b0c7001c4f9abc","readable_key":"Carol Lee","num_emails_sent":215,"num_emails_replied":47,"percent_emails_replied":0.219,"percent_emails_replied_denominator":215},{"key":"60a5c0b8e4b0c7001c4f5678","readable_key":"Bob Jones","num_emails_sent":280,"num_emails_replied":56,"percent_emails_replied":0.2,"percent_emails_replied_denominator":280},{"key":"60a5c0b8e4b0c7001c4f1234","readable_key":"Alice Smith","num_emails_sent":320,"num_emails_replied":48,"percent_emails_replied":0.15,"percent_emails_replied_denominator":320}]}},"group_by_total_response":{},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}},"Custom date range β€” call activity for Q1":{"value":{"response":{"table_response":{"smart_user_id":{"buckets":[{"key":"60a5c0b8e4b0c7001c4f1234","readable_key":"Alice Smith","num_phone_calls":185,"num_phone_calls_connect":62,"percent_phone_calls_connect":0.335,"percent_phone_calls_connect_denominator":185},{"key":"60a5c0b8e4b0c7001c4f5678","readable_key":"Bob Jones","num_phone_calls":140,"num_phone_calls_connect":53,"percent_phone_calls_connect":0.379,"percent_phone_calls_connect_denominator":140}]}},"group_by_total_response":{"smart_user_id":{"buckets":[{"key":"total","readable_key":"Total","num_phone_calls":325,"num_phone_calls_connect":115,"percent_phone_calls_connect":0.354,"percent_phone_calls_connect_denominator":325}]}},"pivot_group_by_total_response":{}},"incompatible_filters":{},"goals":[]}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Missing required parameter":{"value":{"error":"param is missing or the value is empty: metrics"}},"Invalid metric value":{"value":{"error":"Invalid metric type"}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"401":{"description":"401","content":{"text/plain":{"examples":{"Check API key":{"value":"Invalid access credentials."}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"API not accessible":{"value":{"error":"api/v1/reports/sync_report is not accessible with this api_key","error_code":"API_INACCESSIBLE"}}},"schema":{"type":"object","properties":{"error":{"type":"string"},"error_code":{"type":"string"}}}}}},"429":{"description":"429","content":{"application/json":{"examples":{"Too many requests":{"value":{"message":"The maximum number of api calls allowed for api/v1/reports/sync_report is 200 times per hour. Please upgrade your plan from https://app.apollo.io/#/settings/plans/upgrade."}}},"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"deprecated":false}},"/conversations/search":{"post":{"summary":"Search Conversations","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nConversations are prospect video meetings stored in Apollo.

Use the Search Conversations endpoint to find a list of conversations. Several filters are available to help narrow your search, including by type, account, contact, date range, and more. Each result includes a summary of the conversation.

This endpoint doesn't include transcripts or recording URLs. Use the conversation ID retrieved from your search to request full details using Get Conversations Info.","tags":["Conversations"],"operationId":"search-conversations","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","description":"Page number for pagination."},"num_fetch_result":{"type":"integer","description":"Maximum number of results to return."},"conversation_type":{"type":"string","enum":["video_conference","phone_call"],"description":"Filter by dialer calls, or video conference calls."},"account_id":{"type":"string","description":"Filter by account ID."},"contact_ids":{"type":"array","description":"Filter by one or more contact IDs.","items":{"type":"string"}},"tag_ids":{"type":"array","description":"Filter by label or tag IDs.","items":{"type":"string"}},"tracker_ids":{"type":"array","description":"Filter by tracker IDs.","items":{"type":"string"}},"organization_ids":{"type":"array","description":"Filter by organization IDs.","items":{"type":"string"}},"date_range":{"type":"object","description":"Filter by date range.","properties":{"start":{"type":"string","description":"Start date (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values.

Example: 2024-01-01T00:00:00Z"},"end":{"type":"string","description":"End date (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values.

Example: 2024-03-31T23:59:59Z"}}},"scorecard_template_id":{"type":"string","description":"Filter by scorecard template ID."},"scorecard_max_rating":{"type":"number","description":"Maximum scorecard rating to include in the results."},"sort_by_field":{"type":"string","description":"Field to sort results by."},"enforce_contact_boundary":{"type":"boolean","description":"When true, restricts results to conversations visible to the specified contacts."}}},"examples":{"Basic search":{"value":{"page":1,"num_fetch_result":25}},"Filter by account and type":{"value":{"page":1,"num_fetch_result":25,"account_id":"64a1b2c3d4e5f6a7b8c9d0e1","conversation_type":"video_conference"}},"Filter by contact IDs and tags":{"value":{"page":1,"num_fetch_result":25,"contact_ids":["64a1b2c3d4e5f6a7b8c9d0e2","64a1b2c3d4e5f6a7b8c9d0e3"],"tag_ids":["5f9a1b2c3d4e5f6a7b8c9d0e"]}},"Filter by date range":{"value":{"page":1,"num_fetch_result":25,"date_range":{"start":"2024-01-01T00:00:00Z","end":"2024-03-31T23:59:59Z"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","description":"Pagination metadata for the result set.","additionalProperties":true},"breadcrumbs":{"type":"object","description":"Breadcrumbs data associated with the results.","additionalProperties":true},"num_fetch_result":{"type":"integer","description":"Number of results returned."},"playlist_clip_ids":{"type":"array","nullable":true,"description":"IDs of playlist clips associated with the results.","items":{"type":"string"}},"conversations":{"type":"array","description":"List of conversation summaries matching the search criteria.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique conversation ID."},"topic":{"type":"string","description":"Conversation topic or title."},"start_time":{"type":"string","description":"Conversation start time (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values."},"duration":{"type":"integer","description":"Duration of the conversation in seconds."},"state":{"type":"string","description":"Current processing state of the conversation."},"host":{"type":"string","description":"Name of the conversation host."},"host_id":{"type":"string","description":"User ID of the conversation host."},"is_private":{"type":"boolean","description":"Privacy setting of the conversation."},"conversation_type":{"type":"string","enum":["video_conference","phone_call"],"description":"Filter by dialer calls, or video conference calls."},"can_access_conversation":{"type":"boolean","description":"Whether the authenticated user can access this conversation."},"label_id_names":{"type":"object","description":"Label names associated with the conversation.","additionalProperties":true},"participant_names":{"type":"array","description":"Names of the conversation participants.","items":{"type":"string"}},"comment_count":{"type":"integer","description":"Number of comments on the conversation."},"account_names":{"type":"array","description":"Names of associated accounts.","items":{"type":"string"}},"account_ids":{"type":"array","description":"IDs of associated accounts.","items":{"type":"string"}},"organization":{"type":"object","description":"Organization associated with the result.","properties":{"domain":{"type":"string","nullable":true,"description":"Organization domain."},"logo_url":{"type":"string","nullable":true,"description":"Organization logo URL."}}},"participants_info":{"type":"array","description":"Detailed information about conversation participants.","items":{"type":"object"}},"thumbnail_url":{"type":"string","description":"URL of the conversation thumbnail image."},"is_internal":{"type":"boolean","description":"Whether the conversation is internal."},"deals":{"type":"array","description":"Deals associated with the conversation.","items":{"type":"object","properties":{"id":{"type":"string","description":"Deal ID."},"account_name":{"type":"string","description":"Name of the associated account."},"name":{"type":"string","description":"Deal name."},"opportunity_stage_id":{"type":"string","description":"ID of the opportunity stage."}}}}}}}}},"examples":{"Basic search results":{"value":{"pagination":{"page":1,"per_page":25,"total_entries":2,"total_pages":1},"breadcrumbs":{},"num_fetch_result":25,"playlist_clip_ids":[],"conversations":[{"id":"64a1b2c3d4e5f6a7b8c9d0e1","topic":"Q3 Sales Review","start_time":"2024-03-15T14:00:00Z","duration":3600,"state":"insights_generated","host":"Alice Smith","host_id":"60a5c0b8e4b0c7001c4f1234","is_private":false,"conversation_type":"phone_call","can_access_conversation":true,"label_id_names":{"5f9a1b2c3d4e5f6a7b8c9d0e":"Follow-up"},"participant_names":["Alice Smith","Bob Jones"],"comment_count":3,"account_names":["Acme Corp"],"account_ids":["64a1b2c3d4e5f6a7b8c9d0f2"],"participants_info":[],"thumbnail_url":"https://storage.apollo.io/thumbnails/64a1b2c3d4e5f6a7b8c9d0e1.jpg","is_internal":false,"deals":[{"id":"64a1b2c3d4e5f6a7b8c9d0e3","account_name":"Acme Corp","name":"Acme Corp - Enterprise Deal","opportunity_stage_id":"5f9a1b2c3d4e5f6a7b8c9d1f"}]},{"id":"64a1b2c3d4e5f6a7b8c9d0e2","topic":"Product Demo","start_time":"2024-03-16T10:00:00Z","duration":1800,"state":"insights_generated","host":"Bob Jones","host_id":"60a5c0b8e4b0c7001c4f5678","is_private":false,"conversation_type":"phone_call","can_access_conversation":true,"label_id_names":{},"participant_names":["Bob Jones","Carol Lee"],"comment_count":0,"account_names":["Globex Corp"],"account_ids":["64a1b2c3d4e5f6a7b8c9d0f3"],"participants_info":[],"thumbnail_url":"https://storage.apollo.io/thumbnails/64a1b2c3d4e5f6a7b8c9d0e2.jpg","is_internal":false,"deals":[]}]}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Access denied":{"value":{"error":"Access denied."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"deprecated":false}},"/conversations/{id}":{"get":{"summary":"Get Conversations Info","description":"This endpoint consumes Apollo credits per record when conversations with AI insights are returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nConversations are prospect video meetings stored in Apollo.

Use the Get Conversation Info endpoint to retrieve the full details of a single conversation by its ID.

To get a conversation's ID, refer to Search Conversations.","tags":["Conversations"],"operationId":"get-conversations-info","parameters":[{"name":"id","in":"path","required":true,"description":"The conversation ID. Supports an optional share ID in the format id_shareid","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique conversation ID."},"topic":{"type":"string","description":"Conversation topic or title."},"start_time":{"type":"string","description":"Conversation start time (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values."},"duration":{"type":"integer","description":"Duration of the conversation in seconds."},"state":{"type":"string","description":"Current processing state of the conversation."},"host":{"type":"string","description":"Name of the conversation host."},"host_id":{"type":"string","description":"User ID of the conversation host."},"is_private":{"type":"boolean","description":"Privacy setting of the conversation."},"pushed_to_crm":{"type":"boolean","description":"Whether the conversation has been pushed to a CRM."},"account_ids":{"type":"array","description":"IDs of accounts associated with the conversation.","items":{"type":"string"}},"label_id_names":{"type":"array","description":"Map of label IDs to label names associated with the conversation.","items":{"type":"string"}},"is_shared_conversation":{"type":"boolean","description":"Whether the conversation has been shared."},"opportunity_ids":{"type":"array","description":"IDs of opportunities associated with the conversation.","items":{"type":"string"}},"comment_count":{"type":"integer","description":"Number of comments on the conversation."},"failure_code":{"type":"string","nullable":true,"description":"Error code if the conversation processing failed. Returns null if no failure occurred."},"bot_call_ended_reason":{"type":"string","nullable":true,"description":"Reason the bot call ended. Returns null if not applicable."},"conversation_type":{"type":"string","enum":["video_conference","phone_call"],"description":"Type of conversation."},"is_clip":{"type":"boolean","description":"Whether the conversation is a clip."},"video_recording":{"type":"object","description":"Video recording details for the conversation.","properties":{"type_cd":{"type":"string","description":"Video recording type code."},"url":{"type":"string","description":"URL of the video recording."},"state_cd":{"type":"string","description":"Processing state code of the video recording."}}},"audio_recording":{"type":"object","description":"Audio recording details for the conversation.","properties":{"url":{"type":"string","description":"URL of the audio recording."}}},"transcript":{"type":"array","description":"Transcript of the conversation.","items":{"type":"object"}},"participants":{"type":"object","description":"Participants in the conversation, grouped by internal and external.","properties":{"internal":{"type":"array","description":"Internal participants.","items":{"type":"object"}},"external":{"type":"object","description":"External participants.","additionalProperties":true}}},"opportunities":{"type":"array","description":"Opportunities associated with the conversation.","items":{"type":"object","properties":{"id":{"type":"string","description":"Opportunity ID."},"name":{"type":"string","description":"Opportunity name."},"amount":{"type":"number","nullable":true,"description":"Opportunity amount."},"closed_date":{"type":"string","nullable":true,"description":"Close date (ISO 8601)."},"created_at":{"type":"string","description":"Creation timestamp (ISO 8601)."},"last_sync":{"type":"string","nullable":true,"description":"Last CRM sync timestamp (ISO 8601)."},"account":{"type":"object","nullable":true,"description":"Account this opportunity belongs to.","properties":{"id":{"type":"string","description":"Account ID."},"name":{"type":"string","description":"Account name."}}},"crm_record_url":{"type":"string","nullable":true,"description":"Deep link to the opportunity in the connected CRM."},"opportunity_crm_id":{"type":"string","nullable":true,"description":"Opportunity ID in the connected CRM."},"opportunity_stage_id":{"type":"string","nullable":true,"description":"ID of the opportunity stage."},"stage_name":{"type":"string","nullable":true,"description":"Display name of the opportunity stage."},"owner_id":{"type":"string","nullable":true,"description":"User ID of the opportunity owner."},"initial_opportunity_stage_id":{"type":"string","nullable":true,"description":"Original opportunity stage ID when the conversation was first associated."}}}},"playlist_clip_ids":{"type":"array","nullable":true,"description":"IDs of the playlist clips associated with the conversation.","items":{"type":"string"}}}},"examples":{"Conversation with insights":{"value":{"id":"64a1b2c3d4e5f6a7b8c9d0e1","topic":"30 Minute Meeting - Sarah Chen and Marcus Webb","start_time":"2025-03-15T14:00:00.000+00:00","duration":289,"state":"insights_generated","host":"Sarah Chen","host_id":"60a5c0b8e4b0c7001c4f1234","is_private":false,"pushed_to_crm":false,"account_ids":["64a1b2c3d4e5f6a7b8c9d0f2"],"label_id_names":[],"is_shared_conversation":false,"opportunity_ids":["64a1b2c3d4e5f6a7b8c9d0e3"],"comment_count":0,"failure_code":null,"bot_call_ended_reason":"timeout_exceeded_everyone_left","conversation_type":"video_conference","is_clip":false,"video_recording":{"type_cd":"video","url":"https://storage.googleapis.com/apollo-recordings/64a1b2c3d4e5f6a7b8c9d0e1/64a1b2c3d4e5f6a7b8c9d0e1_video.mp4","state_cd":"created"},"transcript":[{"id":"64a1b2c3d4e5f6a7b8c9d0f3","start_time":20880,"end_time":21760,"spoken_sentence":"Hello? Hello? Hello.","words":[["Hello?",20880,21120],["Hello?",21120,21400],["Hello.",21400,21760]],"participant_id":"64a1b2c3d4e5f6a7b8c9d0f4","participant_name":"Sarah Chen"},{"id":"64a1b2c3d4e5f6a7b8c9d0f5","start_time":41050,"end_time":42650,"spoken_sentence":"Yeah, that works. Let's do it.","words":[["Yeah,",41050,41450],["that",41450,41649],["works.",41649,42010],["Let's",42010,42250],["do",42250,42370],["it.",42370,42650]],"participant_id":"64a1b2c3d4e5f6a7b8c9d0f6","participant_name":"Marcus Webb"}],"participants":{"internal":[],"external":{"others":[{"id":"64a1b2c3d4e5f6a7b8c9d0f4","name":"Sarah Chen","email":"sarah.chen@example.com","account_id":null,"organization_id":null,"is_organization":true,"account_name":null,"contact_id":"64a1b2c3d4e5f6a7b8c9d0f8","title":null,"account_stage":null,"account_arr":null,"account_arr_printed":null},{"id":"64a1b2c3d4e5f6a7b8c9d0f6","name":"Marcus Webb","email":null,"account_id":null,"organization_id":null,"is_organization":true,"account_name":null,"contact_id":null,"title":null,"account_stage":null,"account_arr":null,"account_arr_printed":null}]}},"opportunities":[{"id":"64a1b2c3d4e5f6a7b8c9d0e3","name":"Acme Corp - Enterprise Deal","amount":6000,"closed_date":"2025-06-30T00:00:00.000+00:00","created_at":"2025-03-01T10:00:00.000Z","last_sync":null,"account":{"id":"64a1b2c3d4e5f6a7b8c9d0f2","name":"Acme Corp"},"crm_record_url":null,"opportunity_crm_id":null,"opportunity_stage_id":"64a1b2c3d4e5f6a7b8c9d0f7","stage_name":"Lead","owner_id":"60a5c0b8e4b0c7001c4f1234","initial_opportunity_stage_id":null}],"playlist_clip_ids":null}},"Conversation without insights":{"value":{"id":"64a7ff0cc4dfae00013df1a5","topic":"15 minute meeting - Alice Smith","start_time":"2026-02-26T04:45:00.000+00:00","duration":0,"state":"failed","host":"Bob Jones","is_private":null,"host_id":"64b8ee1dd5bf9a00014c2b3e","pushed_to_crm":false,"account_ids":[],"label_id_names":[],"is_shared_conversation":false,"opportunity_ids":[],"comment_count":0,"failure_code":"no_video_url","bot_call_ended_reason":"timeout_exceeded_waiting_room","conversation_type":"video_conference","is_clip":false,"recording_source":"recall","video_recording":{"type_cd":"video","url":null,"state_cd":"created"},"transcript":[],"participants":{"internal":[],"external":{}},"timelines":{"participant_timelines":[],"unknown_participants_timeline":[]},"key_topics":{"tracker_insights":{"trackers_available":true,"trackers":null},"question_insights":[]},"call_summary":{"outcome":null,"pricing_discussion":null,"next_steps":[],"pain_points":[],"objections":[]},"editable_call_summary":{"outcome":null,"pricing_discussion":null,"pain_points":null,"objections":null},"crm_pushed_accounts":[],"accounts":[],"team_id":"64c9aa2ee6c0ab00015d3f7c","spritesheets":[],"has_v1_shares":false,"v2_share_id":null,"auto_deal_field_updates_count":null,"playlist_clip_ids":null,"opportunities":[]}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Conversation not found":{"value":{"error":"Conversation not found or access denied."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Insufficient credits":{"value":{"error":"Insufficient credits. Please upgrade your plan."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"deprecated":false}},"/conversations/export":{"post":{"summary":"Export Conversations","description":"This endpoint consumes Apollo credits when conversations are returned that include AI insights. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nConversations are prospect video meetings stored in Apollo.

Use the Export Conversations endpoint to export conversations within a time range. Exports are processed asynchronously and delivered as a gzipped JSON file. A notification email is sent to the specified team member when the export is ready.

To get the download URL once the export is ready, refer to Get Export.","tags":["Conversations"],"operationId":"export-conversations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["start_time","end_time","email"],"properties":{"start_time":{"type":"string","description":"Start of the export time range (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values. Must be earlier than end_time.

Example: 2024-01-01T00:00:00Z"},"end_time":{"type":"string","description":"End of the export time range (ISO 8601). Apollo uses Greenwich Mean Time (GMT) for all date and time values. Must be later than start_time.

Example: 2024-03-31T23:59:59Z"},"email":{"type":"string","description":"Email address of a valid team member to notify when the export is ready."}}},"examples":{"Export Q1 conversations":{"value":{"start_time":"2024-01-01T00:00:00Z","end_time":"2024-03-31T23:59:59Z","email":"alice@example.com"}},"Export last month":{"value":{"start_time":"2024-02-01T00:00:00Z","end_time":"2024-02-29T23:59:59Z","email":"bob@example.com"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"export_url":{"type":"string","example":"https://app.apollo.io/api/v1/conversations/export/6a060f34585b480015951efd"},"export_id":{"type":"string","example":"6a060f34585b480015951efd"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"conversation_not_found":{"value":{"error":"Unable to find conversations within the given time range."}},"notification_user_not_found":{"value":{"error":"Unable to find user to send notification email to. Please provide an address for a valid user using the email parameter."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Invalid start_time":{"value":{"error":"start_time is not a valid ISO-8601 date."}},"Invalid end_time":{"value":{"error":"end_time is not a valid ISO-8601 date."}},"Invalid time range":{"value":{"error":"start_time must be less than end_time."}},"Insufficient credits":{"value":{"error":"Insufficient credits. Please upgrade your plan."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"deprecated":false}},"/conversations/export/{id}":{"get":{"summary":"Get Conversations Export","description":"This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nConversations are prospect video meetings stored in Apollo.

Use the Get Conversations Export endpoint to retrieve a download URL for your exported conversations.

This endpoint is used as a follow-up to the Export Conversations endpoint.","tags":["Conversations"],"operationId":"get-conversations-export","parameters":[{"name":"id","in":"path","required":true,"description":"The export ID returned by the Export Conversations endpoint.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"redirect_url":{"type":"string","description":"A signed URL to download the exported conversations file."}}},"examples":{"Export ready":{"value":{"redirect_url":"https://storage.googleapis.com/apollo-exports/64a1b2c3d4e5f6a7b8c9d0e1.json.gz?X-Goog-Signature=abc123"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Export not found":{"value":{"error":"Export not found or access denied."}}},"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"deprecated":false}}},"x-readme":{"headers":[{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"}],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}