Introduction
Welcome to Apollo’s API!
Our REST API lets you query our rich data repository and enrich your database, systems, or app. Whether for people, organizations, opportunities, or more, the Apollo API is available to do almost everything the UI offers. In addition to managing data records, you can utilize Apollo’s API to automate outreach efforts and customize workflows.
We are actively developing our API and it is subject to change without prior notice from Apollo. If you have any requests for API methods you’d like to see, please let us know!
Authentication
Sample request:
# With shell, you can just pass the correct header with each request
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/auth/health?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/auth/health"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
If authentication is successful, you should expect to see {"is_logged_in":true}
Apollo uses API keys to allow access to the API. You may request an API key here
Apollo expects the API key to be included in all API requests to the server as a query string parameter.
Rate limits
Sample response:
{
"x-daily-requests-left": 295,
"x-daily-usage": 5,
"x-hourly-requests-left": 95,
"x-hourly-usage": 5,
"x-minute-requests-left": 45,
"x-minute-usage": 5,
"x-rate-limit-daily": 300,
"x-rate-limit-hourly": 100,
"x-rate-limit-minute": 50
}
Requests to our API will be limited in accordance with your current pricing plan, detailed here under Compare Plans > CRM > API Access.
To view how many requests your current plan allows, as well as how many requests you have used, you can reference the headers of a successful response from the API. See the sample response to the right for more detail.
Response headers
| Header name | Description | Example |
|---|---|---|
| x-daily-requests-left | The total requests left for the current 24 hour period | 295 |
| x-daily-usage | The total requests used for the current 24 hour period | 5 |
| x-hourly-requests-left | The total requests left for the current 60 minute period | 95 |
| x-hourly-usage | The total requests used for the current 60 minute period | 5 |
| x-minute-requests-left | The total requests left for the current 60 second period | 45 |
| x-minute-usage | The total requests used for the current 60 second period | 5 |
| x-rate-limit-daily | Based on your plan | 300 |
| x-rate-limit-hourly | Based on your plan | 100 |
| x-rate-limit-minute | Based on your plan | 50 |
Enrichment API
Bulk people enrichment
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"reveal_personal_emails": true,
"details": [
{
"first_name": "Tim",
"last_name": "Zheng",
"domain": "apollo.io",
"email": "tim@apollo.io",
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"organization_name": "Apollo",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010"
},
{
"first_name": "Roy",
"last_name": "Chung",
"email": "roy@apollo.io",
"hashed_email": "97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152",
"organization_name": "Apollo",
"linkedin_url": "http://www.linkedin.com/in/royychung"
}
]
}' "https://api.apollo.io/api/v1/people/bulk_match"
import requests
url = "https://api.apollo.io/api/v1/people/bulk_match"
data = {
"api_key": "YOUR API KEY HERE",
"reveal_personal_emails": true,
"details": [
{
"first_name": "Tim",
"last_name": "Zheng",
"domain": "apollo.io",
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"email": "tim@apollo.io",
"organization_name": "Apollo"
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010"
},
{
"first_name": "Roy",
"last_name": "Chung",
"email": "roy@apollo.io",
"hashed_email": "97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152",
"organization_name": "Apollo"
"linkedin_url": "http://www.linkedin.com/in/royychung"
}
]
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"status": "success",
"error_code": null,
"error_message": null,
"total_requested_enrichments": 2,
"unique_enriched_records": 2,
"missing_records": 0,
"credits_consumed": 1.01,
"matches": [
{
"id": "6453e9bd8f50d40001f1e348",
"first_name": "Tim",
"last_name": "Zheng",
"name": "Tim Zheng",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010",
"title": "Founder & CEO",
"email_status": null,
"photo_url": "https://media.licdn.com/dms/image/D5603AQEFiVRxq2aFCg/profile-displayphoto-shrink_200_200/0/1676521918175?e=1701907200&v=beta&t=6QqL_xwsDybj-FIUTr6XaEeLyrHxs7QS-IHSbVtYCak",
"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": "651e57392998d400013ac5bd",
"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": "651e57392998d400013ac5bd",
"key": "651e57392998d400013ac5bd"
},
{
"_id": "651e57392998d400013ac5be",
"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": "651e57392998d400013ac5be",
"key": "651e57392998d400013ac5be"
},
{
"_id": "651e57392998d400013ac5bf",
"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": "651e57392998d400013ac5bf",
"key": "651e57392998d400013ac5bf"
},
{
"_id": "651e57392998d400013ac5c0",
"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": "651e57392998d400013ac5c0",
"key": "651e57392998d400013ac5c0"
},
{
"_id": "651e57392998d400013ac5c1",
"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": "64cca0e9f6489200019570a1",
"organization_name": "Goldman Sachs",
"raw_address": null,
"start_date": "2010-06-01",
"title": "Summer Analyst",
"updated_at": null,
"id": "651e57392998d400013ac5c1",
"key": "651e57392998d400013ac5c1"
},
{
"_id": "651e57392998d400013ac5c2",
"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": "651e57392998d400013ac5c2",
"key": "651e57392998d400013ac5c2"
}
],
"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": {
"number": "+1415-640-9303",
"source": "Owler",
"country_code_added_from_hq": true
},
"languages": [],
"alexa_ranking": 3514,
"phone": "+1415-640-9303",
"linkedin_uid": "18511550",
"founded_year": 2015,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/64beb2c5e966df0001384ac1/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"sanitized_phone": "+14156409303",
"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",
"demand generation"
],
"estimated_num_employees": 1200,
"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",
"street_address": "535 Mission Street",
"city": "San Francisco",
"state": "California",
"postal_code": "94105",
"country": "United States"
},
"account_id": "64dcd04136650700bc538f61",
"account": {
"id": "64dcd04136650700bc538f61",
"name": "Apollo",
"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": {
"number": "+1415-640-9303",
"source": "Owler",
"country_code_added_from_hq": true
},
"languages": [],
"alexa_ranking": 3514,
"phone": "+1(202) 374-1312",
"linkedin_uid": "18511550",
},
"phone_numbers": [
{
"raw_number": "+1415-640-9303",
"sanitized_number": "+14156409303",
"type": "work_hq",
"position": 0,
"status": "no_status",
"dnc_status": null,
"dnc_other_info": null
}
],
"intent_strength": null,
"show_intent": false,
"revealed_for_current_team": true,
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"personal_emails": [],
"departments": [
"c_suite"
],
"subdepartments": [
"executive",
"founder"
],
"functions": [
"entrepreneurship"
],
"seniority": "founder"
},
{
"id": "611c931f1b404b00014e884c",
"first_name": "Roy",
"last_name": "Chung",
"name": "Roy Chung",
"linkedin_url": "http://www.linkedin.com/in/royychung",
"title": "Entrepreneur",
"email_status": null,
"photo_url": "https://media.licdn.com/dms/image/C5603AQFVolaIjLeG3g/profile-displayphoto-shrink_800_800/0/1517707907539?e=1701302400&v=beta&t=JFd1eHlKnvAfz77El2lIOAmRFZpmvz6uiRzpP1hqs70",
"twitter_url": "https://twitter.com/r1strategy",
"github_url": null,
"facebook_url": null,
"extrapolated_email_confidence": null,
"headline": "Ideating & Optimizing 💪📈🧪️",
"email": "roy@apollo.io",
"organization_id": "627b71bc1c295500a55e4928",
"employment_history": [
{
"_id": "651534cefdb6690001d16b63",
"created_at": null,
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "627b71bc1c295500a55e4928",
"organization_name": "Stealth",
"raw_address": null,
"start_date": "2022-07-01",
"title": "Entrepreneur",
"updated_at": null,
"id": "651534cefdb6690001d16b63",
"key": "651534cefdb6690001d16b63"
},
{
"_id": "651534cefdb6690001d16b64",
"created_at": null,
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "5dba6791a2edd900e79a4b48",
"organization_name": "Flow Research Collective",
"raw_address": null,
"start_date": "2019-11-01",
"title": "Strategy",
"updated_at": null,
"id": "651534cefdb6690001d16b64",
"key": "651534cefdb6690001d16b64"
},
{
"_id": "651534cefdb6690001d16b65",
"created_at": null,
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "5b1314cda6da98dcb8928c42",
"organization_name": "Pioneer Fund",
"raw_address": null,
"start_date": "2021-01-01",
"title": "Venture Partner",
"updated_at": null,
"id": "651534cefdb6690001d16b65",
"key": "651534cefdb6690001d16b65"
},
{
"_id": "651534cefdb6690001d16b66",
"created_at": null,
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "60c554c05c097d00d9155e20",
"organization_name": "JoyFund",
"raw_address": null,
"start_date": "2019-05-01",
"title": "Venture Partner",
"updated_at": null,
"id": "651534cefdb6690001d16b66",
"key": "651534cefdb6690001d16b66"
},
{
"_id": "651534cefdb6690001d16b67",
"created_at": null,
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "5e562f92440ea5000178a0b1",
"organization_name": "Lionheart Ventures",
"raw_address": null,
"start_date": "2020-01-01",
"title": "Venture Partner",
"updated_at": null,
"id": "651534cefdb6690001d16b67",
"key": "651534cefdb6690001d16b67"
}
],
"state": "New York",
"city": "New York",
"country": "United States",
"organization": {
"id": "627b71bc1c295500a55e4928",
"name": "Stealth",
"website_url": null,
"blog_url": null,
"angellist_url": null,
"linkedin_url": "http://www.linkedin.com/company/ice9",
"twitter_url": null,
"facebook_url": null,
"primary_phone": {},
"languages": [],
"alexa_ranking": null,
"phone": null,
"linkedin_uid": "80022788",
"founded_year": null,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/645166e576ec8b00010ea120/picture",
"crunchbase_url": null,
"primary_domain": null,
"industry": "venture capital & private equity",
"keywords": [],
"estimated_num_employees": 110,
"industries": [
"venture capital & private equity"
],
"secondary_industries": [],
"snippets_loaded": true,
"industry_tag_id": "5567e1587369641c48370000",
"industry_tag_hash": {
"venture capital & private equity": "5567e1587369641c48370000"
},
"retail_location_count": 0,
"raw_address": "Dallas, Texas",
"street_address": "",
"city": "Dallas",
"state": "Texas",
"postal_code": null,
"country": "United States"
},
"intent_strength": null,
"show_intent": false,
"revealed_for_current_team": true,
"hashed_email": "97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152",
"personal_emails": [
"royychung@gmail.com"
],
"departments": [
"c_suite"
],
"subdepartments": [
"founder"
],
"functions": [
"entrepreneurship"
],
"seniority": "entry"
}
]
}
This endpoint enriches people information in bulk - the more information you pass in, the more likely we can find a match.
Up to 10 records can be enriched at the same time through this endpoint. This endpoint unveils the email addresses of new people. It will deduct 1 email credit for each verified email found and 1 export credit for teams utilizing Export Credits (in newer plans) for each non-empty record returned
Rate limits
Rate limits on this endpoint are 1/10th of what is available on the single enrichment endpoint.
POST https://api.apollo.io/api/v1/people/bulk_match
Request parameters
| Parameter | Description | Example |
|---|---|---|
| first_name (optional) | The person's first name | Tim |
| last_name (optional) | The person's last name | Zheng |
| name (optional) | The person's full name | Tim Zheng |
| email (optional) | The person's email | example@domain.com |
| hashed_email (optional) | The person's md5 or sha256 hashed email | 8d935115b9ff4489f2d1f9249503cadf OR 97817c0c49994eb500ad0a5e7e2d8aed 51977b26424d508f66e4e8887746a152 |
| organization_name (optional) | The person's company name | Apollo Inc. |
| domain (optional) | The person's company domain | apollo.io |
| id (optional) | The person's ID obtained from the search endpoint | "583f2f7ed9ced98ab5bfXXXX" |
| linkedin_url (optional) | The person's linkedin URL | http://www.linkedin.com/in/tim-zheng |
| reveal_personal_emails (optional) | Flag to reveal personal emails. Note: Personal emails will not be revelead for GDPR compliant regions | true |
| reveal_phone_number (optional) | Flag to reveal phone number | true |
| webhook_url (optional) | Webhook URL for sending 'reveal_phone_number' response | "https://example.com/hook" |
Bulk organization enrichment
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"domains": [
"apollo.io",
"outreach.com",
"microsoft.com"
]
}' "https://api.apollo.io/api/v1/organizations/bulk_enrich"
import requests
url = "https://api.apollo.io/api/v1/organizations/bulk_enrich"
data = {
"api_key": "YOUR API KEY HERE",
"domains": [
"apollo.io",
"outreach.com",
"microsoft.com"
]
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"status":"success",
"error_code":null,
"error_message":null,
"total_requested_domains":3,
"unique_domains":3,
"unique_enriched_records":3,
"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":{
"number":"+1 415-763-6055",
"source":"Owler"
},
"languages":[
],
"alexa_ranking":2651,
"phone":"+1 415-763-6055",
"linkedin_uid":"18511550",
"founded_year":2015,
"publicly_traded_symbol":null,
"publicly_traded_exchange":null,
"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/6232fbed6106460001ca5dc7/picture",
"crunchbase_url":null,
"primary_domain":"apollo.io",
"persona_counts":{
},
"industry":"computer software",
"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",
"demand generation"
],
"estimated_num_employees":210,
"snippets_loaded":true,
"industry_tag_id":"5567cd4e7369643b70010000",
"retail_location_count":0,
"raw_address":"535 mission st, suite 1100, san francisco, california 94105, us",
"street_address":"535 Mission St",
"city":"San Francisco",
"state":"California",
"country":"United States",
"postal_code":"94105",
"owned_by_organization_id":null,
"account_id":"6182b6670e22be00ded90b0f",
"account":{
"id":"6182b6670e22be00ded90b0f",
"domain":"apollo.io",
"name":"Apollo.io",
"team_id":"6181a50999668600ded6fe71",
"organization_id":"5e66b6381e05b4008c8331b8",
"account_stage_id":"6181a50999668600ded6fe7c",
"source":"deployment",
"original_source":"deployment",
"owner_id":"6181a50a99668600ded6feed",
"created_at":"2021-11-03T16:18:47.229Z",
"phone":"2023741312",
"phone_status":"no_status",
"test_predictive_score":null,
"hubspot_id":null,
"salesforce_id":null,
"crm_owner_id":null,
"parent_account_id":null,
"sanitized_phone":"+12023741312",
"account_playbook_statuses":[
{
"_id":"61844b47a4258e00c2499c8e",
"added_by_id":"6181a50a99668600ded6feed",
"added_on":"2021-11-04T21:06:15.053+00:00",
"completed_step_ids":[
"6184391f26e0aa00a4ccc56b"
],
"created_at":null,
"current_step_id":"61844dba8b94530112288546",
"finished_reason_cd":"completed_all_steps",
"paused_reason_cd":null,
"playbook_id":"6184388a0515e4008cbf5129",
"position":2,
"status_cd":"finished",
"updated_at":null,
"id":"61844b47a4258e00c2499c8e",
"key":"61844b47a4258e00c2499c8e"
}
],
"existence_level":"full",
"label_ids":[
],
"typed_custom_fields":{
"618438b906b01300da086546":"Google, Okta, Lyft"
},
"modality":"account",
"persona_counts":{
}
},
"departmental_head_count":{
"engineering":46,
"business_development":14,
"support":21,
"finance":2,
"marketing":10,
"administrative":1,
"product_management":7,
"arts_and_design":8,
"operations":7,
"accounting":2,
"entrepreneurship":3,
"information_technology":2,
"consulting":9,
"human_resources":6,
"sales":17,
"education":3,
"legal":0,
"media_and_commmunication":0,
"data_science":0
}
},
{
"id":"55ea57fdf3e5bb1430000ac7",
"name":"Outreach, Inc.",
"website_url":"http://www.outreach.com",
"blog_url":null,
"angellist_url":null,
"linkedin_url":"http://www.linkedin.com/company/outreach-inc-",
"twitter_url":null,
"facebook_url":"https://www.facebook.com/outreachinc",
"primary_phone":{
"number":"+1 800-991-6011",
"source":"Owler"
},
"languages":[
"English",
"English"
],
"alexa_ranking":597090,
"phone":"+1 800-991-6011",
"linkedin_uid":"314305",
"founded_year":1996,
"publicly_traded_symbol":null,
"publicly_traded_exchange":null,
"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/623369279d4f650001b93cb3/picture",
"crunchbase_url":null,
"primary_domain":"outreach.com",
"persona_counts":{
},
"industry":"marketing \u0026 advertising",
"keywords":[
"outreach marketing product for christian churches",
"customized design services",
"professional design",
"print \u0026 full service delivery",
"targeted mailings done by inhouse mail services",
"thought leader in outreach",
"resource provider \u0026 content network",
"churches",
"marketing",
"professional services",
"religious organizations"
],
"estimated_num_employees":170,
"snippets_loaded":true,
"industry_tag_id":"5567cd467369644d39040000",
"retail_location_count":1,
"raw_address":"5550 tech center drive, colorado springs, co 80919, us",
"street_address":"5550 Tech Center Drive",
"city":"Colorado Springs",
"state":"Colorado",
"country":"United States",
"postal_code":"80919",
"owned_by_organization_id":null,
"departmental_head_count":{
"accounting":3,
"operations":4,
"finance":2,
"arts_and_design":5,
"human_resources":3,
"sales":11,
"marketing":8,
"media_and_commmunication":7,
"product_management":3,
"engineering":5,
"consulting":6,
"support":4,
"entrepreneurship":2,
"information_technology":5,
"business_development":1,
"administrative":2,
"legal":0,
"education":0,
"data_science":0
}
},
{
"id":"5d09312ca3ae61489386b467",
"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/microsoft",
"facebook_url":"https://facebook.com/Microsoft",
"primary_phone":{
"number":"+1 425-882-8080",
"source":"Owler"
},
"languages":[
"English"
],
"alexa_ranking":19,
"phone":"+1 425-882-8080",
"linkedin_uid":"1035",
"founded_year":1975,
"publicly_traded_symbol":"MSFT",
"publicly_traded_exchange":"nasdaq",
"logo_url":"https://zenprospect-production.s3.amazonaws.com/uploads/pictures/6232f7976d60b600019c2644/picture",
"crunchbase_url":null,
"primary_domain":"microsoft.com",
"persona_counts":{
},
"market_cap":"2099.6B",
"industry":"computer software",
"keywords":[
"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":224000,
"snippets_loaded":true,
"industry_tag_id":"5567cd4e7369643b70010000",
"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,
"departmental_head_count":{
"sales":10117,
"business_development":9413,
"engineering":66732,
"media_and_commmunication":1612,
"finance":3079,
"marketing":5327,
"operations":3747,
"support":12733,
"consulting":5822,
"product_management":4099,
"data_science":1922,
"administrative":350,
"education":13249,
"human_resources":3818,
"arts_and_design":2125,
"information_technology":3727,
"legal":625,
"accounting":476,
"entrepreneurship":121
}
}
]
}
This endpoint enriches organization information in bulk with info such as industry, company size, etc. based on the domain parameter passed in.
Up to 10 records can be enriched at the same time through this endpoint. Newer plans utilizing Export Credits will be deducting 1 export credit when calling this endpoint.
Rate limits
Rate limits on this endpoint are 1/10th of what is available on the single enrichment endpoint.
POST https://api.apollo.io/api/v1/organizations/bulk_enrich
Request parameters
| Parameter | Description | Example |
|---|---|---|
| domains | The company domain | google.com |
People enrichment
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"id": "583f2f7ed9ced98ab5bfXXXX",
"first_name": "Tim",
"last_name": "Zheng",
"organization_name": "Apollo",
"email": "name@domain.io",
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"domain": "apollo.io",
"reveal_personal_emails": true,
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010"
}' "https://api.apollo.io/v1/people/match"
import requests
url = "https://api.apollo.io/v1/people/match"
data = {
"api_key": "YOUR API KEY HERE",
"id": "583f2f7ed9ced98ab5bfXXXX",
"first_name": "Tim",
"last_name": "Zheng",
"organization_name": "Apollo",
"email": "name@domain.io",
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"domain": "apollo.io",
"reveal_personal_emails": true,
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"person": {
"id": "6453e9bd8f50d40001f1e348",
"first_name": "Tim",
"last_name": "Zheng",
"name": "Tim Zheng",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010",
"title": "Founder & CEO",
"email_status": null,
"photo_url": "https://media.licdn.com/dms/image/D5603AQEFiVRxq2aFCg/profile-displayphoto-shrink_200_200/0/1676521918175?e=1701907200&v=beta&t=6QqL_xwsDybj-FIUTr6XaEeLyrHxs7QS-IHSbVtYCak",
"twitter_url": null,
"github_url": null,
"facebook_url": null,
"extrapolated_email_confidence": null,
"headline": "Founder & CEO at Apollo",
"email": "name@domain.io",
"organization_id": "5e66b6381e05b4008c8331b8",
"employment_history": [
{
"_id": "651e57392998d400013ac5bd",
"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": "651e57392998d400013ac5bd",
"key": "651e57392998d400013ac5bd"
},
{
"_id": "651e57392998d400013ac5be",
"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": "651e57392998d400013ac5be",
"key": "651e57392998d400013ac5be"
},
{
"_id": "651e57392998d400013ac5bf",
"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": "651e57392998d400013ac5bf",
"key": "651e57392998d400013ac5bf"
}
],
"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": {
"number": "+1415-640-9303",
"source": "Owler",
"country_code_added_from_hq": true
},
"languages": [],
"alexa_ranking": 3514,
"phone": "+1415-640-9303",
"linkedin_uid": "18511550",
"founded_year": 2015,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/64beb2c5e966df0001384ac1/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"sanitized_phone": "+14156409303",
"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",
"demand generation"
],
"estimated_num_employees": 1200,
"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",
"street_address": "535 Mission Street",
"city": "San Francisco",
"state": "California",
"postal_code": "94105",
"country": "United States",
"owned_by_organization_id": null,
"suborganizations": [],
"num_suborganizations": 0,
"seo_description": "Search, engage, and convert over 265 million contacts at over 70 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 🦄",
"annual_revenue_printed": "345.6M",
"annual_revenue": 345600000.0,
"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": "6520fc8e0f5b210001b5285b",
"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": "6520fc8f0f5b210001b52860",
"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": "$"
}
]
},
"phone_numbers": [
{
"raw_number": "+1415-640-9303",
"sanitized_number": "+14156409303",
"type": "work_hq",
"position": 0,
"status": "no_status",
"dnc_status": null,
"dnc_other_info": null
}
],
"intent_strength": null,
"show_intent": false,
"revealed_for_current_team": true,
"hashed_email": "8d935115b9ff4489f2d1f9249503cadf",
"personal_emails": [],
"departments": [
"c_suite"
],
"subdepartments": [
"executive",
"founder"
],
"functions": [
"entrepreneurship"
],
"seniority": "founder"
}
}
This endpoint enriches a person's information, the more information you pass in, the more likely we can find a match. This endpoint unveils the email addresses of new people. It will deduct 1 email credit for each verified email found and 1 export credit for teams utilizing Export Credits (in newer plans) for each non-empty record returned
POST https://api.apollo.io/v1/people/match
Query parameters
| Parameter | Description | Example |
|---|---|---|
| first_name (optional) | The person's first name | Tim |
| last_name (optional) | The person's last name | Zheng |
| name (optional) | The person's full name | Tim Zheng |
| email (optional) | The person's email | example@domain.com |
| hashed_email (optional) | The person's md5 or sha256 hashed email | 8d935115b9ff4489f2d1f9249503cadf OR 97817c0c49994eb500ad0a5e7e2d8aed 51977b26424d508f66e4e8887746a152 |
| organization_name (optional) | The person's company name | Apollo Inc. |
| domain (optional) | The person's company domain | apollo.io |
| id (optional) | The person's ID obtained from the search endpoint | "583f2f7ed9ced98ab5bfXXXX" |
| linkedin_url (optional) | The person's linkedin URL | http://www.linkedin.com/in/tim-zheng |
| reveal_personal_emails (optional) | Flag to reveal personal emails. Note: Personal emails will not be revealed for GDPR compliant regions | true |
| reveal_phone_number (optional) | Flag to reveal phone number | true |
| webhook_url (optional) | Webhook URL for sending 'reveal_phone_number' response | "https://example.com/hook" |
Organization enrichment
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/organizations/enrich?api_key=YOUR_API_KEY_HERE&domain=apollo.io"
import requests
url = "https://api.apollo.io/v1/organizations/enrich"
querystring = {
"api_key": "YOUR API KEY HERE",
"domain": "apollo.io"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"organization": {
"id": "5e66b6XXXXXXXXXXXXXXXXXX",
"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": {
"number": "202374XXXX",
"source": "Account"
},
"languages": [],
"alexa_ranking": 522,
"phone": "202374XXXX",
"linkedin_uid": "185115XX",
"founded_year": 2015,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://apollo-server.com/uploads/pictures/61824XXXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"persona_counts": {},
"industry": "computer software",
"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",
"demand generation"
],
"estimated_num_employees": 170,
"snippets_loaded": true,
"industry_tag_id": "5567cdXXXXXXXXXXXXXXXXXX",
"retail_location_count": 0,
"raw_address": "535 Mission St, Suite 1100, San Francisco, California 94105, US",
"street_address": "535 Mission St",
"city": "San Francisco",
"state": "California",
"postal_code": "94105",
"country": "United States",
"owned_by_organization_id": null,
"suborganizations": [],
"num_suborganizations": 0,
"seo_description": "Apollo is a data-first engagement platform that embeds intelligence within your workflows to help you execute, analyze, and improve on your growth strategy.",
"short_description": "Apollo is the unified engagement acceleration platform that gives reps the ability to dramatically increase their number of quality conversations and opportunities. Reps are empowered do more than just conduct outreach, they learn who to target, how to reach out, and what to say at speed and scale. We help drive growth and success by providing the means for teams to discover and utilize their organization’s unique best practices. \n\nBy working in a unified platform, reps and managers alike save hours of time each day, strategy changes are instantly scaled across the whole team, and managers can finally dig into data at each step of their pipeline to continually find new ways to improve. \n\nTeams get access to our database of 200+ million contacts with a built-in fully customizable Scoring Engine, full sales engagement stack, our native Account Playbook builder, and the industry’s only custom deep analytics suite. Managers create and enforce order and process with the industry’s most advanced Rules Engine.\n\nApollo is the foundation for your entire end-to-end sales strategy.\n\nJoin teams like Autodesk, Copper (ProsperWorks), and Snowflake to experience the future of sales today. Ready to join our crew? Email sales@apollo.io. ",
"annual_revenue_printed": "10M",
"annual_revenue": 10000000,
"total_funding": 9200000,
"total_funding_printed": "9.2M",
"latest_funding_round_date": "2018-06-26T00:00:00.000+00:00",
"latest_funding_stage": "Series A",
"funding_events": [
{
"id": "5ffe93XXXXXXXXXXXXXXXXXX",
"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",
"amount": "7M",
"currency": "$"
},
{
"id": "5ffe93XXXXXXXXXXXXXXXXXX",
"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": [
"Cloudflare DNS",
"Mailchimp Mandrill",
"Gmail",
"Marketo",
"Google Apps",
"Microsoft Office 365",
"CloudFlare Hosting",
"Route 53",
"Zendesk",
"Google Cloud Hosting",
"Stripe",
"Lever",
"Segment.io",
"Amplitude",
"Hubspot",
"Nginx",
"CrazyEgg",
"Squarespace ECommerce",
"Linkedin Marketing Solutions",
"Yandex Metrica",
"Mobile Friendly",
"Typekit",
"Google Tag Manager"
],
"current_technologies": [
{
"uid": "cloudflare_dns",
"name": "Cloudflare DNS",
"category": "Domain Name Services"
},
{
"uid": "mailchimp_mandrill",
"name": "Mailchimp Mandrill",
"category": "Email Delivery"
},
{
"uid": "gmail",
"name": "Gmail",
"category": "Email Providers"
},
{
"uid": "marketo",
"name": "Marketo",
"category": "Marketing Automation"
}
],
"account_id": "614264XXXXXXXXXXXXXXXXXX",
"account": {
"id": "614264XXXXXXXXXXXXXXXXXX",
"domain": "apollo.io",
"name": "Apollo",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"account_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"source": "salesforce",
"original_source": "salesforce",
"owner_id": "5c1004XXXXXXXXXXXXXXXXXX",
"created_at": "2021-09-15T21:24:18.374Z",
"phone": "(123) 456-XXXX",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0015g0XXXXXXXXXXXX",
"crm_owner_id": "0055g0XXXXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+112345XXXXX",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"typed_custom_fields": {},
"modality": "account",
"persona_counts": {}
},
"departmental_head_count": {
"engineering": 45,
"accounting": 4,
"product_management": 5,
"support": 31,
"arts_and_design": 10,
"sales": 37,
"education": 6,
"consulting": 10,
"human_resources": 10,
"business_development": 22,
"operations": 10,
"finance": 8,
"entrepreneurship": 4,
"marketing": 7,
"information_technology": 5,
"administrative": 3,
"legal": 0,
"media_and_commmunication": 0,
"data_science": 0
}
}
}
This endpoint enriches a company with info such as industry, company size, etc. based on the domain parameter passed in. Newer plans utilizing Export Credits will be deducting 1 export credit when calling this endpoint.
GET https://api.apollo.io/v1/organizations/enrich
Query parameters
| Parameter | Description | Example |
|---|---|---|
| domain | The company domain | google.com |
People API
A person represents a person in Apollo's database.
Search
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"q_organization_domains": "apollo.io\ngoogle.com",
"page" : 1,
"per_page": 10,
"organization_locations": ["California, US"],
"person_seniorities": ["senior", "manager"],
"organization_num_employees_ranges": ["1,1000000"],
"person_titles" : ["sales manager", "engineer manager"]
}' "https://api.apollo.io/v1/mixed_people/search"
import requests
url = "https://api.apollo.io/v1/mixed_people/search"
data = {
"api_key": "YOUR API KEY HERE",
"q_organization_domains": "apollo.io\ngoogle.com",
"page" : 1,
"per_page": 10,
"organization_locations": ["California, US"],
"person_seniorities": ["senior", "manager"],
"organization_num_employees_ranges": ["1,1000000"],
"person_titles" : ["sales manager", "engineer manager"]
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"breadcrumbs": [
{
"label": "Titles",
"signal_field_name": "person_titles",
"value": "sales manager",
"display_name": "sales manager"
},
{
"label": "Titles",
"signal_field_name": "person_titles",
"value": "engineer manager",
"display_name": "engineer manager"
},
{
"label": "# Employees",
"signal_field_name": "organization_num_employees_ranges",
"value": "1,1000000",
"display_name": "1-1000000"
},
{
"label": "Management Level",
"signal_field_name": "person_seniorities",
"value": "senior",
"display_name": "Senior"
},
{
"label": "Management Level",
"signal_field_name": "person_seniorities",
"value": "manager",
"display_name": "Manager"
},
{
"label": "Company Locations",
"signal_field_name": "organization_locations",
"value": "California, US",
"display_name": "California, US"
},
{
"label": "Company Domains",
"signal_field_name": "q_organization_domains",
"value": [
"apollo.io",
"google.com"
],
"display_name": "apollo.io, google.com"
}
],
"partial_results_only": false,
"disable_eu_prospecting": false,
"partial_results_limit": 10000,
"pagination": {
"page": 1,
"per_page": 10,
"total_entries": 2145,
"total_pages": 215
},
"contacts": [],
"people": [
{
"id": "618a24XXXXXXXXXXXXXXXXXX",
"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-exp1.licdn.com/sc/h/244xhbkr7g40x6bsu4gi6q4ry",
"twitter_url": null,
"github_url": null,
"facebook_url": null,
"extrapolated_email_confidence": null,
"headline": "Founder & CEO at Apollo",
"email": "email_not_unlocked@domain.com",
"employment_history": [
{
"_id": "618afbXXXXXXXXXXXXXXXXXX",
"created_at": "2021-11-09T22:51:18.531Z",
"current": true,
"degree": null,
"description": null,
"emails": null,
"end_date": null,
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"organization_name": "Apollo",
"raw_address": null,
"start_date": "2015-01-01",
"title": "Founder & CEO",
"updated_at": "2021-11-09T22:51:18.531Z",
"id": "618afbXXXXXXXXXXXXXXXXXX",
"key": "618afbXXXXXXXXXXXXXXXXXX"
},
{
"_id": "618afbXXXXXXXXXXXXXXXXXX",
"created_at": "2021-11-09T22:51:18.536Z",
"current": false,
"degree": null,
"description": null,
"emails": null,
"end_date": "2014-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": "2021-11-09T22:51:18.536Z",
"id": "618afbXXXXXXXXXXXXXXXXXX",
"key": "618afbXXXXXXXXXXXXXXXXXX"
},
{
"_id": "618afbXXXXXXXXXXXXXXXXXX",
"created_at": "2021-11-09T22:51:18.536Z",
"current": false,
"degree": null,
"description": null,
"emails": null,
"end_date": "2011-01-01",
"grade_level": null,
"kind": null,
"major": null,
"organization_id": "54a22fXXXXXXXXXXXXXXXXXX",
"organization_name": "Citadel Investment Group",
"raw_address": null,
"start_date": "2011-01-01",
"title": "Investment & Trading Associate",
"updated_at": "2021-11-09T22:51:18.536Z",
"id": "618afbXXXXXXXXXXXXXXXXXX",
"key": "618afbXXXXXXXXXXXXXXXXXX"
}
],
"state": "Texas",
"city": "Austin",
"country": "United States",
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"organization": {
"id": "5e66b6XXXXXXXXXXXXXXXXXX",
"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": {
"number": "(202) 374-XXXX",
"source": "Account"
},
"languages": [],
"alexa_ranking": 685,
"phone": "(202) 374-XXXX",
"linkedin_uid": "185115XX",
"founded_year": 2015,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://apollo-server.com/uploads/pictures/6188cXXXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"persona_counts": {}
},
"account_id": "616d0eXXXXXXXXXXXXXXXXXX",
"account": {
"id": "616d0eXXXXXXXXXXXXXXXXXX",
"name": "Apollo",
"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": {
"number": "(202) 374-XXXX",
"source": "Account"
},
"languages": [],
"alexa_ranking": 685,
"phone": "(123) 456-XXXX",
"linkedin_uid": "185115XX",
"founded_year": 2015,
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://apollo-server.com/uploads/pictures/6188cXXXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"persona_counts": {},
"domain": "apollo.io",
"team_id": "5c1004a041f5ac0995d5f5e8",
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"account_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"source": "crm",
"original_source": "crm",
"owner_id": null,
"created_at": "2021-10-18T06:03:45.774Z",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": "699261XXXX",
"salesforce_id": null,
"crm_owner_id": "511281XX",
"parent_account_id": null,
"sanitized_phone": "+112345XXXXX",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"typed_custom_fields": {},
"modality": "account",
"hubspot_record_url": "https://app.hubspot.com/sales/25200013/company/699261XXXX",
"salesloft_id": "233684XX",
"salesloft_url": "https://app.salesloft.com/app/company/233684XX"
},
"departments": [
"c_suite",
"master_information_technology",
"master_operations"
],
"subdepartments": [
"operations_executive",
"business_service_management_itsm",
"operations"
],
"functions": [
"operations"
],
"seniority": "c_suite"
}
]
}
This endpoint searches for people and does not return any new email information. To get email information, use the "enrich" endpoint. Newer plans utilizing Export Credits will be deducting 1 export credit when calling this endpoint. This feature is not accessible to Apollo users on free plans.
POST https://api.apollo.io/v1/mixed_people/search
Query parameters
| Parameter | Description | Example |
|---|---|---|
| person_titles (optional) | An array of the person's title. Apollo will return results matching ANY of the titles passed in | ["sales director", "engineer manager"] |
| q_keywords (optional) | A string of words over which we want to filter the results | "Tim" |
| prospected_by_current_team (optional) | An array of string booleans defining whether we want models prospected by current team or not. "no" means to look in net new database only, "yes" means to see saved contacts only | ["no"] |
| person_locations (optional) | An array of strings denoting allowed locations of the person | ["California, US", "Minnesota, US"] |
| person_seniorities (optional) | An array of strings denoting the seniorities or levels | ["senior", "manager"] |
| contact_email_status (optional) | An array of strings to look for people having a set of email statuses | ["verified", "guessed", "unavailable", "bounced", "pending_manual_fulfillment"] |
| q_organization_domains (optional) | An array of the company domains to search for, joined by the new line character. | "google.com\nfacebook.com" |
| organization_locations (optional) | An array of strings denoting allowed locations of organization headquarters of the person | ["California, US", "Minnesota, US"] |
| organization_ids (optional) | An array of organization ids obtained from companies-search | ["63ff0bc1ff57ba0001e7eXXX"] |
| organization_num_employees_ranges (optional) | An array of intervals to include people belonging in an organization having number of employees in a range | ["1,10", "101,200" ] |
| page (optional) | An integer that allows you to paginate through the results | 1 |
| per_page (optional) | An integer to load per_page results on a page. Should be in inclusive range [1, 100] | 10 |
Return results
"people" are people in Apollo's database. "contacts" are people already in your linked CRM.
Organizations API
An organization represents a company in Apollo's database.
Organization jobs postings
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/organizations/ORGANIZATION_ID/job_postings?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/organizations/ORGANIZATION_ID/job_postings"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"organization_job_postings": [
{
"id": "5ed76XXXXXXXXXXXXXXXX",
"title": "Product Marketing Manager, Security",
"url": "https://www.linkedin.com/jobs/view/product-marketing-manager-security-at-google-1878106711?refId=e19c8d31-7452-4bfc-8097-66ab00fe06a8&position=14&pageNum=9&trk=public_jobs_job-result-card_result-card_full-click",
"city": "San Francisco",
"state": "California",
"country": "United States",
"last_seen_at": "2020-06-03T09:09:57.751+00:00",
"posted_at": "2020-06-03T07:09:57.751+00:00"
},
{
"id": "5ed768XXXXXXXXXXXXXXXX",
"title": "Product Marketing Manager, Security",
"url": "https://www.linkedin.com/jobs/view/product-marketing-manager-security-at-google-1878108613?refId=e19c8d31-7452-4bfc-8097-66ab00fe06a8&position=17&pageNum=9&trk=public_jobs_job-result-card_result-card_full-click",
"city": "Sunnyvale",
"state": "California",
"country": "United States",
"last_seen_at": "2020-06-03T09:09:57.754+00:00",
"posted_at": "2020-06-03T07:09:57.754+00:00"
},
{
"id": "5ed768XXXXXXXXXXXXXXXX",
"title": "Staff Software Engineer, Platforms, Google Cloud",
"url": "https://www.linkedin.com/jobs/view/staff-software-engineer-platforms-google-cloud-at-google-1878104847?refId=e19c8d31-7452-4bfc-8097-66ab00fe06a8&position=18&pageNum=9&trk=public_jobs_job-result-card_result-card_full-click",
"city": "Sunnyvale",
"state": "California",
"country": "United States",
"last_seen_at": "2020-06-03T09:09:57.755+00:00",
"posted_at": "2020-07-30T07:32:24.298+00:00"
}
]
}
Get a list of active job postings for a company.
GET https://api.apollo.io/v1/organizations/ORGANIZATION_ID/job_postings
Query parameters
| Parameter | Description | Example |
|---|---|---|
| id | The id of the organization (i.e. NOT account id). You can obtain this with a company's domain by using the enrich endpoint. | 54fca1087369647fcXXXXXXX |
Organization search
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"page": 1,
"per_page": 10,
"organization_num_employees_ranges": ["1,100", "1,1000"],
"organization_locations": ["United States"],
"q_organization_keyword_tags": ["sales strategy", "lead"],
"q_organization_name": "Apollo.io"
}' "https://api.apollo.io/api/v1/mixed_companies/search"
import requests
url = "https://api.apollo.io/api/v1/mixed_companies/search"
data = {
"api_key": "YOUR API KEY HERE",
"page":1,
"per_page":10,
"organization_num_employees_ranges":["1,100", "1,1000"],
"organization_locations":["United States"],
"q_organization_keyword_tags":["sales strategy", "lead"],
"q_organization_name":"Apollo.io"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"breadcrumbs": [
{
"label": "Company Name",
"signal_field_name": "q_organization_name",
"value": "Apollo.io",
"display_name": "Apollo.io"
},
{
"label": "# Employees",
"signal_field_name": "organization_num_employees_ranges",
"value": "1,100",
"display_name": "1-100"
},
{
"label": "# Employees",
"signal_field_name": "organization_num_employees_ranges",
"value": "1,1000",
"display_name": "1-1000"
},
{
"label": "Company Locations",
"signal_field_name": "organization_locations",
"value": "United States",
"display_name": "United States"
},
{
"label": "Company Keywords Contain ANY Of",
"signal_field_name": "q_organization_keyword_tags",
"value": "sales strategy",
"display_name": "sales strategy"
},
{
"label": "Company Keywords Contain ANY Of",
"signal_field_name": "q_organization_keyword_tags",
"value": "lead",
"display_name": "lead"
}
],
"partial_results_only": false,
"disable_eu_prospecting": false,
"partial_results_limit": 10000,
"pagination": {
"page": 1,
"per_page": 10,
"total_entries": 1,
"total_pages": 1
},
"accounts": [
{
"id": "63b3e47f0deb820001XXXXX",
"name": "Apollo.io",
"website_url": null,
"blog_url": null,
"angellist_url": null,
"linkedin_url": "http://www.linkedin.com/company/apolXXXXX",
"twitter_url": "https://twitter.com/MeetApolXXXXX/",
"facebook_url": "https://facebook.com/MeetApoXXXXX/",
"primary_phone": {
"number": "+1 415-640-9303",
"source": "Account"
},
"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/63d3a127e242df0001eXXXXX/picture",
"crunchbase_url": null,
"primary_domain": null,
"sanitized_phone": "+14156409303",
"owned_by_organization_id": null,
"organization_raw_address": "535 mission st, suite 1100, san francisco, california 94105, us",
"organization_city": "San Francisco",
"organization_street_address": "535 Mission St",
"organization_state": "California",
"organization_country": "United States",
"organization_postal_code": "94105",
"suggest_location_enrichment": false,
"parent_account": {
"id": "62b5283531e821000XXXXX",
"name": "Apollo.io"
},
"domain": "apollo.io",
"team_id": "551e3ef072616951471XXXXX",
"organization_id": "65080f223660ac000XXXXX",
"account_stage_id": "5711a6247ff0bb33edXXXXX",
"source": "job_change",
"original_source": "job_change",
"creator_id": null,
"owner_id": "5eaf980991763800eXXXXX",
"created_at": "2023-01-03T08:17:03.163Z",
"phone_status": "no_status",
"hubspot_id": null,
"salesforce_id": "0015a00003AXXXXX",
"crm_owner_id": "0052L000003XXXXX",
"parent_account_id": "62b5283531e82100012XXXXX",
"account_playbook_statuses": [],
"account_rule_config_statuses": [],
"existence_level": "full",
"label_ids": [],
"typed_custom_fields": {
"5b7aff6c55884769e38XXXXX": 7.0,
"5ee1d989add32701128XXXXX": "0015a00003AjsaS",
"5f28afc474e70000f12XXXXX": "High Tier"
},
"modality": "account",
"salesforce_record_url": "https://apolloio.my.salesforce.com/0015a00003AjsXXXXX",
"contact_emailer_campaign_ids": [
"6488dbeb72e68a00d9XXXXX"
],
"contact_campaign_status_tally": {
"finished": 6,
"paused": 4,
"not_sent": 1,
"active": 1
},
"num_contacts": 17,
"last_activity_date": "2023-09-26T05:31:52.000+00:00",
"intent_strength": null,
"show_intent": true
}
],
"organizations": [],
"model_ids": [
"63b3e47f0deb820001fXXXXX"
],
"num_fetch_result": null,
"derived_params": {
"recommendation_config_id": "650bc3a2c7d5a700d09XXXXX"
}
}
This endpoint searches for organizations. Newer plans utilizing Export Credits will be deducting 1 export credit when calling this endpoint. This feature is not accessible to Apollo users on free plans.
POST https://api.apollo.io/api/v1/mixed_companies/search
Query parameters
| Parameter | Description | Example |
|---|---|---|
| organization_ids (optional) | An array of organization ids obtained from companies-search | ["63ff0bc1ff57ba0001e7eXXX"] |
| organization_num_employees_ranges (optional) | An array of intervals to include organizations having number of employees in a range | ["1,10", "101,200" ] |
| organization_locations (optional) | An array of strings denoting allowed locations of organization headquarters | ["California, US", "Minnesota, US"] |
| organization_not_locations (optional) | An array of strings denoting un-allowed locations of organization headquarters | ["Chicago, US"] |
| q_organization_keyword_tags (optional) | An array of strings denoting the keywords an organization should be associated with | ["sales strategy", "lead"] |
| prospected_by_current_team (optional) | An array of string booleans defining whether we want models prospected by current team or not. "no" means to look in net new database only, "yes" means to see saved organizations only | ["no"] |
| q_organization_name (optional) | A string representing the name of the organization we want to filter | "Apollo" |
| page (optional) | An integer that allows you to paginate through the results | 1 |
| per_page (optional) | An integer to load per_page results on a page. Should be in inclusive range [1, 100] | 10 |
Return results
"organizations" are organizations in Apollo's database. "accounts" are organizations already in your linked CRM.
Opportunities API
Opportunities are records that you can use to track possible deals with your prospective customers. Opportunities can be associated with both companies and people in Apollo.
Create opportunity
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"owner_id":"5c10XXXXXXXXXXXXXXXXXXXX",
"name":"Opportunity Name",
"amount":"200",
"opportunity_stage_id":"5c14XXXXXXXXXXXXXXXXXXXX",
"closed_date":"2020-12-18",
"account_id":"5f06XXXXXXXXXXXXXXXXXXXX"
}' "https://app.apollo.io/api/v1/opportunities"
import requests
url = "https://app.apollo.io/api/v1/opportunities"
data = {
"api_key": "YOUR API KEY HERE",
"owner_id":"5c10XXXXXXXXXXXXXXXXXXXX",
"name":"Opportunity Name",
"amount":"200",
"opportunity_stage_id":"5c14XXXXXXXXXXXXXXXXXXXX",
"closed_date":"2020-12-18",
"account_id":"5f06XXXXXXXXXXXXXXXXXXXX"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"opportunity": {
"id": "5fdcXXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"salesforce_owner_id": null,
"amount": 200.0,
"closed_date": "2020-12-18T00:00:00.000+00:00",
"account_id": "5f06XXXXXXXXXXXXXXXXXXXX",
"description": null,
"is_closed": null,
"is_won": null,
"name": "Opportunity Name",
"stage_name": null,
"opportunity_stage_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"salesforce_id": null,
"created_at": "2020-12-18T10:41:54.591Z",
"existence_level": "none",
"opportunity_contact_roles": []
}
}
POST https://api.apollo.io/v1/opportunities
| Parameter | Description |
|---|---|
| owner_id | Owner ID . You can GET a list of possible users and their associated information from misc/users |
| name | Opportunity name |
| amount | The amount of money involved in the opportunity/ deal |
| opportunity_stage_id | The ID of the current stage .You can get a list of all opportunity stages from misc/opportunity stages |
| closed_date | The date the opportunity was closed |
| account_id | ID of the account |
Get all opportunities
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/opportunities/search?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/opportunities/search"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"breadcrumbs": [],
"opportunities": [
{
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5c100XXXXXXXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051U000XXXXXXXXXX",
"amount": 90000.0,
"closed_date": "2018-08-27T15:00:00.000+00:00",
"account_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"description": null,
"is_closed": true,
"is_won": true,
"name": "Apollo Inc",
"stage_name": "Closed Won",
"opportunity_stage_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {
"5c10XXXXXXXXXXXXXXXXXXXX": [],
"5c10XXXXXXXXXXXXXXXXXXXXX": [
"5c14XXXXXXXXXXXXXXXXXXXX"
]
},
"source": "crm",
"salesforce_id": "0061U000XXXXXXXXXX",
"created_at": "2018-12-14T21:36:02.191Z",
"existence_level": "full",
"opportunity_contact_roles": [],
"salesforce_record_url": "https://na85.salesforce.com/0061U000XXXXXXXXXX",
"account": {
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"domain": "apollo.io",
"name": "Apollo Inc",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"source": "csv_import",
"original_source": "salesforce",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"created_at": "2018-12-14T21:35:57.141Z",
"phone": "(312) 596-1000",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011U000XXXXXXXXXX",
"crm_owner_id": "0051U000XXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+1312XXXXXXX",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011U000XXXXXXXXXX",
"contact_emailer_campaign_ids": [],
"contact_campaign_status_tally": {},
"num_contacts": 0,
"last_activity_date": null,
"persona_counts": {}
}
},
{
"id": "5e1fXXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051U000XXXXXXXXXX",
"amount": 10.0,
"closed_date": "2020-01-31T16:00:00.000+00:00",
"account_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"description": null,
"is_closed": false,
"is_won": false,
"name": "Sample Opportunity",
"stage_name": "Qualification",
"opportunity_stage_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"source": "crm",
"salesforce_id": "0061U000XXXXXXXXXX",
"created_at": "2020-01-16T00:41:30.834Z",
"existence_level": "full",
"opportunity_contact_roles": [],
"salesforce_record_url": "https://na85.salesforce.com/0061U000XXXXXXXXXX",
"account": {
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"domain": "apollooportunity.com",
"name": "Apollo Oportunity Limited",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": "5c100XXXXXXXXXXXXXXXXXXXX",
"source": "salesforce",
"original_source": "salesforce",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"created_at": "2018-12-14T21:35:57.141Z",
"phone": "(512) 757-6000",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011U000XXXXXXXXXX",
"crm_owner_id": "0051U000XXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+1512XXXXXXX",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011U000XXXXXXXXXX",
"contact_emailer_campaign_ids": [],
"contact_campaign_status_tally": {},
"num_contacts": 0,
"last_activity_date": null,
"persona_counts": {}
}
}
]
This endpoint returns all opportunities you have created.
GET https://api.apollo.io/v1/opportunities
View opportunity
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/opportunities/REPLACE_WITH_OPPORTUNITY_ID?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/opportunities/REPLACE_WITH_OPPORTUNITY_ID"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"opportunity": {
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051U000001FAqXQAW",
"amount": 90000.0,
"closed_date": "2018-08-27T15:00:00.000+00:00",
"account_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"description": null,
"is_closed": true,
"is_won": true,
"name": "Grand Apollo SLA",
"stage_name": "Closed Won",
"opportunity_stage_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"source": "crm",
"salesforce_id": "0061U000XXXXXXXXXX",
"created_at": "2018-12-14T21:36:02.191Z",
"existence_level": "full",
"opportunity_contact_roles": [],
"salesforce_record_url": "https://na85.salesforce.com/0061U000XXXXXXXXXX",
"num_contacts": 0
}
}
This endpoint returns the full information about an opportunity.
You can GET a list of all created opportunities from opportunities/all
GET https://api.apollo.io/v1/opportunities/REPLACE_WITH_OPPORTUNITY_ID
Update opportunity
Sample request:
curl -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"name": "Opportunity Name Updated",
}' "https://api.apollo.io/v1/opportunities"
import requests
url = "https://api.apollo.io/v1/opportunities"
data = {
"api_key": "YOUR API KEY HERE",
"name": "Opportunity Name Updated",
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.patch(url, headers=headers, data=data)
print(response.text)
Sample response:
{
"opportunity": {
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051U000001FAqXQAW",
"amount": 90000.0,
"closed_date": "2018-08-27T15:00:00.000+00:00",
"account_id": "5c14XXXXXXXXXXXXXXXXXXXX",
"description": null,
"is_closed": true,
"is_won": true,
"name": "Opportunity Name Updated",
"stage_name": "Closed Won",
"opportunity_stage_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"source": "crm",
"salesforce_id": "0061U000XXXXXXXXXX",
"created_at": "2018-12-14T21:36:02.191Z",
"existence_level": "full",
"opportunity_contact_roles": [],
"salesforce_record_url": "https://na85.salesforce.com/0061U000XXXXXXXXXX",
"num_contacts": 0
}
}
Update the details of an already existing opportunity.
You can GET a list of all created opportunities from opportunities/all
PATCH https://api.apollo.io/v1/opportunities/REPLACE_WITH_OPPORTUNITY_ID
Contacts API
A contact is a person your team has explicitly added to your database. It can be from prospected from Apollo, manually added by your team, or created by the API.
Create a contact
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"first_name": "Jon",
"last_name": "Snow",
"title": "Lord Commander",
"organization_name": "Westeros"
}' "https://api.apollo.io/v1/contacts"
import requests
url = "https://api.apollo.io/v1/contacts"
data = {
"api_key": "YOUR API KEY HERE",
"first_name": "Jonny",
"last_name": "Snow",
"title": "Lord Commander",
"organization_name": "Apollo",
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contact": {
"id": "5f34e4XXXXXXXXXXXXXXXXXX",
"first_name": "Jon",
"last_name": "Snow",
"name": "Jon Snow",
"linkedin_url": null,
"title": "Lord Commander",
"contact_stage_id": "5c48fb3XXXXXXXXXXXXXXXXXX",
"owner_id": "5cc77dXXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Westeros",
"source": "api",
"original_source": "api",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0,
"salesforce_id": null,
"salesforce_lead_id": null,
"salesforce_contact_id": null,
"salesforce_account_id": null,
"salesforce_owner_id": null,
"created_at": "2020-08-13T06:56:09.789Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": null,
"account_id": null,
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-08-13T06:56:09.789Z",
"queued_for_crm_push": true,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": null,
"contact_campaign_statuses": [],
"next_contact_id": null,
"time_zone": null,
"city": null,
"state": null,
"country": null,
"phone_numbers": [],
"account_phone_note": null
},
"labels": [],
"team": {
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"contacts_finder_empty": false
}
}
POST https://api.apollo.io/v1/contacts
| Parameter | Description | Example |
|---|---|---|
| first_name | First name | "Jon" |
| last_name | Last name | "Snow" |
| organization_name | Company name | "Westeros Inc." |
| title | Title | "Lord Commander" |
| account_id | ID of the Account (Optional) | "583f2f7ed9ced98ab5bfXXXX" |
| Email. Invalid emails will be ignored. | "jon.snow@westeros.com" | |
| website_url | The organization website Apollo can use to enrich data for you. DO NOT pass in personal social media URLs such as "http://www.linkedin.com/profile_url", or your data will be incorrectly enriched. This argument will be ignored if you pass in a valid email. | "http://www.westeros.com" |
| label_names | A list of names to tag this newly created contact. If the name does not exist, Apollo will automatically create it | ["inbound contact", "smb clients"] |
| contact_stage_id | Assign contact to this stage, if the contact does not yet exist. Get a list of possible stage ids with GET /contact_stages | "583f2f7ed9ced98ab5bfXXXX" |
| present_raw_address | The address string for this contact, Apollo will intelligently infer the city, state, country, and time zone from your address | "San Francisco" |
| direct_phone | The direct dial phone for this contact. | "123-456-7890" |
| corporate_phone | The corporate phone for this contact. | "123-456-7890" |
| mobile_phone | The mobile phone for this contact. | "123-456-7890" |
| home_phone | The home phone for this contact. | "123-456-7890" |
| other_phone | Phone of unknown type for this contact. | "123-456-7890" |
Update a contact
Sample request:
curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"first_name": "Jon",
"last_name": "Snow",
"email": "jon.snow@westeros.com",
"title": "Lord Commander",
"organization_name": "Westeros"
}' "https://api.apollo.io/v1/contacts/YOUR_CONTACT_ID"
import requests
url = "https://api.apollo.io/v1/contacts/YOUR_CONTACT_ID"
data = {
"api_key": "YOUR API KEY HERE",
"first_name": "Jon",
"last_name": "Snow",
"email": "jon.snow@westeros.com",
"title": "Lord Commander",
"organization_name": "Westeros"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contact": {
"id": "5f34e4XXXXXXXXXXXXXXXXXX",
"first_name": "Jon",
"last_name": "Snow",
"name": "Jon Snow",
"linkedin_url": null,
"title": "Lord Commander",
"contact_stage_id": "5c48fbXXXXXXXXXXXXXXXXXX",
"owner_id": "5cc77dXXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Westeros",
"source": "api",
"original_source": "api",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0,
"salesforce_id": null,
"salesforce_lead_id": null,
"salesforce_contact_id": null,
"salesforce_account_id": null,
"salesforce_owner_id": null,
"created_at": "2020-08-13T06:56:09.789Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": true,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": null,
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-08-13T07:21:10.336Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "jon.snow@westeros.com",
"next_contact_id": null,
"time_zone": null,
"city": null,
"state": null,
"country": null,
"crm_job": {
"id": "5f34e6XXXXXXXXXXXXXXXXXX",
"note": "storage limit exceeded",
"job_type": "push_contacts",
"retry_at": "2020-08-13T07:17:19.707+00:00",
"status": "failed",
"created_at": "2020-08-13T07:07:19.696Z"
},
"phone_numbers": [],
"account_phone_note": null
},
"labels": []
}
This endpoint takes a YOUR_CONTACT_ID field at the end of the request URL to update a contact
PUT https://api.apollo.io/v1/contacts/YOUR_CONTACT_ID
| Parameter | Description | Example |
|---|---|---|
| first_name | First name | "Jon" |
| last_name | Last name | "Snow" |
| organization_name | Company name | "Westeros Inc." |
| title | Title | "Lord Commander" |
| account_id | ID of the Account (Optional) | "583f2f7ed9ced98ab5bfXXXX" |
| "jon.snow@westeros.com" | ||
| label_names | A list of names to tag this contact. If the name does not exist, Apollo will automatically create it | ["inbound contact", "smb clients"] |
| present_raw_address | The address string for this contact, Apollo will intelligently infer the city, state, and country from your address | "San Francisco" |
| direct_phone | The direct dial phone for this contact. If the contact already has a direct dial, this overwrites it. If a contact does not already have a direct dial, this ADDS a new direct dial on top of existing phone numbers | "123-456-7890" |
| corporate_phone | The corporate phone for this contact. If the contact already has a corporate phone, this overwrites it. If a contact does not already have a corporate phone, this ADDS a new corporate phone on top of existing phone numbers | "123-456-7890" |
| mobile_phone | The mobile phone for this contact. If the contact already has a mobile phone, this overwrites it. If a contact does not already have a mobile phone, this ADDS a new mobile phone on top of existing phone numbers | "123-456-7890" |
| home_phone | The home phone for this contact. If the contact already has a home phone, this overwrites it. If a contact does not already have a home phone, this ADDS a new home phone on top of existing phone numbers | "123-456-7890" |
| other_phone | Phone of unknown type for this contact. If the contact already has phone of unknown type, this overwrites it. If a contact does not already have phone of unknown type, this ADDS a new phone on top of existing phone numbers | "123-456-7890" |
Search for contacts
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"q_keywords": "Tim Zheng, CEO, Apollo",
"sort_by_field": "contact_last_activity_date",
"sort_ascending": false
}' "https://api.apollo.io/v1/contacts/search"
import requests
url = "https://api.apollo.io/v1/contacts/search"
data = {
"api_key": "YOUR API KEY HERE",
"q_keywords": "Tim Zheng, CEO, Apollo",
"sort_by_field": "contact_last_activity_date",
"sort_ascending": False,
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contacts": [
{
"id": "5da8ceXXXXXXXXXXXXXXXXXX",
"first_name": "Tim",
"last_name": "Zheng",
"name": "Tim Zheng",
"linkedin_url": "http://www.linkedin.com/in/tim-zheng-677ba010",
"title": "Founder & CEO",
"contact_stage_id": "5c48fbXXXXXXXXXXXXXXXXXX",
"owner_id": "5c1004XXXXXXXXXXXXXXXXXX",
"person_id": "5f2b88XXXXXXXXXXXXXXXXXX",
"email_needs_tickling": false,
"organization_name": "Apollo",
"source": "search",
"original_source": "email_import",
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"headline": "Founder & CEO at Apollo",
"photo_url": "https://some-url.fyvrk",
"present_raw_address": "San Francisco, California, United States",
"linkedin_uid": "38777275",
"extrapolated_email_confidence": 0,
"salesforce_id": "0031UXXXXXXXXXXXXXX",
"salesforce_lead_id": null,
"salesforce_contact_id": "0031UXXXXXXXXXXXXXXX",
"salesforce_account_id": "0011UXXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051UXXXXXXXXXXXXXXX",
"created_at": "2019-10-17T20:25:07.594Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": "5f1fadXXXXXXXXXXXXXXXXXX",
"last_activity_date": "2018-06-26T16:30:35.000+00:00",
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {
"5d856eXXXXXXXXXXXXXXXXXX": "Tim Zheng"
},
"updated_at": "2020-07-28T04:44:51.448Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "random@somedomain.com",
"salesforce_record_url": "https://na85.salesforce.com/0031UXXXXXXXXXXXXXXXXXX",
"contact_campaign_statuses": [],
"state": "California",
"city": "San Francisco",
"country": "United States",
"account": {
"id": "5f1fadXXXXXXXXXXXXXXXXXX",
"name": "Apollo",
"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/",
"languages": [],
"alexa_ranking": 77520,
"phone": null,
"linkedin_uid": "18511550",
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://apollo-server.com/uploads/pictures/5f0265XXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"starred_by_user_ids": [],
"persona_counts": {},
"domain": "apollo.io",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": "5e66b6XXXXXXXXXXXXXXXXXX",
"account_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"source": "salesforce",
"original_source": "salesforce",
"owner_id": "5c1004XXXXXXXXXXXXXXXXXX",
"created_at": "2020-07-28T04:44:13.821Z",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011UXXXXXXXXXX",
"salesforce_owner_id": "0051UXXXXXXXXXX",
"parent_account_id": null,
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011UXXXXXXXXXXX"
},
"organization": {
"id": "5e66b6XXXXXXXXXXXXXXXXXX",
"name": "Apollo",
"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/",
"languages": [],
"alexa_ranking": 77520,
"phone": null,
"linkedin_uid": "18511550",
"publicly_traded_symbol": null,
"publicly_traded_exchange": null,
"logo_url": "https://apollo-server.com/uploads/pictures/5f0265XXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": null,
"primary_domain": "apollo.io",
"starred_by_user_ids": [],
"persona_counts": {}
},
"phone_numbers": [],
"account_phone_note": null,
"contact_job_change_event": null
}
],
"breadcrumbs": [
{
"label": "Contains Keywords",
"signal_field_name": "q_keywords",
"value": "Tim Zheng, CEO, Apollo",
"display_name": "Tim Zheng, CEO, Apollo"
}
],
"partial_results_only": false,
"disable_eu_prospecting": false,
"partial_results_limit": 10000,
"pagination": {
"page": 1,
"per_page": 25,
"total_entries": 1,
"total_pages": 1
},
"num_fetch_result": null
}
This feature is not accessible to Apollo users on free plans.
POST https://api.apollo.io/v1/contacts/search
| Parameter | Description |
|---|---|
| q_keywords | The contact's name, title, company, or email |
| contact_stage_ids | An array of stage ids the contact must belong to. Refer to /contact_stages to get a list of possible stage ids. |
| sort_by_field | Possible values: "contact_last_activity_date", "contact_email_last_opened_at", "contact_email_last_clicked_at", "contact_created_at", or "contact_updated_at" |
| sort_ascending | Possible values: true or false |
| page | Which page to return. Defaults to 1 |
Get a list of contact stages
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/contact_stages?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/contact_stages"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"contact_stages": [
{
"id": "5c48fbXXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Cold",
"name": "Cold",
"display_order": 0,
"ignore_trigger_override": false,
"category": "in_progress"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Approaching",
"name": "Approaching",
"display_order": 1,
"ignore_trigger_override": null,
"category": "in_progress"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Replied",
"name": "Replied",
"display_order": 2,
"ignore_trigger_override": null,
"category": "in_progress"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Interested",
"name": "Interested",
"display_order": 3,
"ignore_trigger_override": true,
"category": "succeeded"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Not Interested",
"name": "Not Interested",
"display_order": 4,
"ignore_trigger_override": true,
"category": "failed"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Unresponsive",
"name": "Unresponsive",
"display_order": 5,
"ignore_trigger_override": null,
"category": "failed"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Do Not Contact",
"name": "Do Not Contact",
"display_order": 6,
"ignore_trigger_override": true,
"category": "failed"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Bad Data",
"name": "Bad Data",
"display_order": 7,
"ignore_trigger_override": null,
"category": null
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Changed Job",
"name": "Changed Job",
"display_order": 8,
"ignore_trigger_override": true,
"category": null
}
]
}
GET https://api.apollo.io/v1/contact_stages
Update contact stage
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"contact_ids": ["contact_id1", "contact_id2"],
"contact_stage_id": "stage_id"
}' "https://api.apollo.io/v1/contacts/update_stages"
import requests
url = "https://api.apollo.io/v1/contacts/update_stages"
data = {
"api_key": "YOUR API KEY HERE",
"contact_ids": ["contact_id1", "contact_id2"],
"contact_stage_id": "stage_id"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contacts": [
{
"id": "5f34e4XXXXXXXXXXXXXXXXXX",
"first_name": "Jon",
"last_name": "Snow",
"name": "Jon Snow",
"linkedin_url": null,
"title": "Lord Commander",
"contact_stage_id": "new_contact_stage_id",
"owner_id": "5cc77dXXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Westeros",
"source": "api",
"original_source": "api",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0,
"salesforce_id": null,
"salesforce_lead_id": null,
"salesforce_contact_id": null,
"salesforce_account_id": null,
"salesforce_owner_id": null,
"created_at": "2020-08-13T06:56:09.789Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": true,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": null,
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-08-13T07:49:02.989Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "jon.snow@westeros.com",
"contact_campaign_statuses": [],
"phone_numbers": [],
"account_phone_note": null
}
]
}
POST https://api.apollo.io/v1/contacts/update_stages
Query parameters
| Parameter | Description |
|---|---|
| contact_ids | An array of contact ids. You can filter for a list of contact IDS with the contacts/search API. |
| contact_stage_id | The contact stage id to change into. You can GET a list of possible stage ids and its associated information from /contact_stages |
Update contact ownership
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"contact_ids": ["contact_id1", "contact_id2"],
"owner_id": "owner_id"
}' "https://api.apollo.io/v1/contacts/update_owners"
import requests
url = "https://api.apollo.io/v1/contacts/update_owners"
data = {
"api_key": "YOUR API KEY HERE",
"contact_ids": ["contact_id1", "contact_id2"],
"owner_id": "owner_id"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contacts": [
{
"id": "5f34e4XXXXXXXXXXXXXXXXXX",
"first_name": "Jon",
"last_name": "Snow",
"name": "Jon Snow",
"linkedin_url": null,
"title": "Lord Commander",
"contact_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"owner_id": "new_owner_id",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Westeros",
"source": "api",
"original_source": "api",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0,
"salesforce_id": null,
"salesforce_lead_id": null,
"salesforce_contact_id": null,
"salesforce_account_id": null,
"salesforce_owner_id": null,
"created_at": "2020-08-13T06:56:09.789Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": true,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": null,
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-08-13T07:49:02.989Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "jon.snow@westeros.com",
"contact_campaign_statuses": [],
"phone_numbers": [],
"account_phone_note": null
}
]
}
POST https://api.apollo.io/v1/contacts/update_owners
Query parameters
| Parameter | Description |
|---|---|
| contact_ids | An array of contact ids. You can filter for a list of contact IDS with the contacts/search API. |
| owner_id | The owner id to change into. You can GET a list of possible users and its associated information from /users |
Accounts API
An account is a company your team has explicitly added to your database. It can be from prospected from Apollo, manually added by your team, or created by the API.
Create an account
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"name": "Google",
"domain": "google.com",
"phone_number": "1-866-246-6453",
"raw_address": "1600 Amphitheatre Parkway"
}' "https://api.apollo.io/v1/accounts"
import requests
url = "https://api.apollo.io/v1/accounts"
data = {
"api_key": "YOUR API KEY HERE",
"name": "Google",
"domain": "google.com",
"phone_number": "1-866-246-6453",
"raw_address": "1600 Amphitheatre Parkway"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"account": {
"id": "5fe0XXXXXXXXXXXXXXXXXXXX",
"domain": "google.com",
"name": "Google",
"team_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"source": "api",
"original_source": "api",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2020-12-21T15:33:02.709Z",
"phone": null,
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": null,
"crm_owner_id": null,
"parent_account_id": null,
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"persona_counts": {}
},
"team": {
"id": "5fc6XXXXXXXXXXXXXXXXXXX",
"accounts_finder_empty": false
}
}
POST https://api.apollo.io/v1/accounts
| Parameter | Description |
|---|---|
| name | The account's name |
| domain | The domain of the account you are adding |
| phone_number | The corporate phone for this account. |
| raw_address | The address string for this account, Apollo will intelligently infer the city, state, country, and time zone from your address |
Update an account
Sample request:
curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"name": "new name "
}' "https://api.apollo.io/v1/accounts/YOUR_ACCOUNT_ID"
import requests
url = "https://api.apollo.io/v1/accounts/YOUR_ACCOUNT_ID"
data = {
"api_key": "YOUR API KEY HERE",
"name": "new name ",
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"account": {
"id": "5fe0XXXXXXXXXXXXXXXXXXXX",
"domain": "google.com",
"name": "new name",
"team_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"source": "api",
"original_source": "api",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2020-12-21T15:55:01.956Z",
"phone": null,
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": null,
"crm_owner_id": null,
"parent_account_id": null,
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"persona_counts": {}
},
"labels": []
}
This endpoint takes a YOUR_ACCOUNT_ID field at the end of the request URL to update an account
PUT https://api.apollo.io/v1/accounts/YOUR_ACCOUNT_ID
| Parameter | Description |
|---|---|
| name | The account's name |
| domain | The domain of the account you are updating |
| phone_number | The corporate phone for this account. |
Search for accounts
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"q_organization_name": "Google",
"sort_by_field": "account_last_activity_date",
"sort_ascending": false
}' "https://api.apollo.io/v1/accounts/search"
import requests
url = "https://api.apollo.io/v1/accounts/search"
data = {
"api_key": "YOUR API KEY HERE",
"q_organization_name": "Google",
"sort_by_field": "account_last_activity_date",
"sort_ascending": False
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"breadcrumbs": [
{
"label": "Company Name",
"signal_field_name": "q_organization_name",
"value": "Google",
"display_name": "Google"
}
],
"partial_results_only": false,
"disable_eu_prospecting": false,
"partial_results_limit": 10000,
"pagination": {
"page": 1,
"per_page": 25,
"total_entries": 2,
"total_pages": 1
},
"accounts": [
{
"id": "5c3d15XXXXXXXXXXXXXXXXXX",
"name": "Google",
"website_url": "http://www.google.com",
"blog_url": null,
"angellist_url": "http://angel.co/google",
"linkedin_url": "http://www.linkedin.com/company/google",
"twitter_url": "http://twitter.com/google",
"facebook_url": "https://www.facebook.com/Google",
"languages": [
"English",
"German",
"Spanish",
"French",
"Italian",
"Portuguese",
"Chinese",
"Japanese",
"Russian",
"English"
],
"alexa_ranking": 1,
"phone": "(512) 225-6000",
"linkedin_uid": "1441",
"publicly_traded_symbol": "GOOG",
"publicly_traded_exchange": "nasdaq",
"logo_url": "https://zen-server.com/uploads/pictures/5f2d7fXXXXXXXXXXXXXXXXXX/picture",
"crunchbase_url": "https://www.crunchbase.com/organization/google",
"primary_domain": "google.com",
"starred_by_user_ids": [],
"persona_counts": {},
"market_cap": "835.5B",
"organization_raw_address": "1600 Amphitheatre Parkway, Mountain View, CA",
"organization_city": "Mountain View",
"organization_street_address": "1600 Amphitheatre Parkway",
"organization_state": "California",
"organization_country": "United States",
"organization_postal_code": "94043",
"suggest_location_enrichment": false,
"domain": "google.com",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": "54fca10XXXXXXXXXXXXXXXXXX",
"account_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"source": "csv_import",
"original_source": "csv_import",
"owner_id": "5c1004XXXXXXXXXXXXXXXXXX",
"created_at": "2019-01-14T23:05:07.335Z",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011UXXXXXXXXXXXXXX",
"salesforce_owner_id": "0051UXXXXXXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+15122256000",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011UXXXXXXXXXXXX",
"contact_emailer_campaign_ids": [],
"contact_campaign_status_tally": {},
"num_contacts": 12,
"last_activity_date": null
}
],
"num_fetch_result": null
}
This feature is not accessible to Apollo users on free plans.
POST https://api.apollo.io/v1/accounts/search
| Parameter | Description |
|---|---|
| q_organization_name | The account's name |
| account_stage_ids | An array of stage ids the account must belong to. Refer to /account_stages to get a list of possible stage ids. |
| sort_by_field | Possible values: "account_last_activity_date" or "account_created_at" |
| sort_ascending | Possible values: true or false |
| page | which page to return. Defaults to 1 |
Get a list of account stages
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/account_stages?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/account_stages"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"account_stages": [
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Cold",
"name": "Cold",
"display_order": 0,
"default_exclude_for_leadgen": false,
"category": "in_progress"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Current Client",
"name": "Current Client",
"display_order": 1,
"default_exclude_for_leadgen": true,
"category": "succeeded"
},
{
"id": "5c1004a04XXXXXXXXXXXXXX",
"team_id": "5c1004aXXXXXXXXXXXXXXXX",
"display_name": "Active Opportunity",
"name": "Active Opportunity",
"display_order": 2,
"default_exclude_for_leadgen": true,
"category": "succeeded"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Dead Opportunity",
"name": "Dead Opportunity",
"display_order": 3,
"default_exclude_for_leadgen": false,
"category": "failed"
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"display_name": "Do Not Prospect",
"name": "Do Not Prospect",
"display_order": 4,
"default_exclude_for_leadgen": true,
"category": "failed"
}
]
}
GET https://api.apollo.io/v1/account_stages
Update account stage
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"account_ids": ["account_id1", "account_id2"],
"account_stage_id": "stage_id"
}' "https://api.apollo.io/v1/accounts/bulk_update"
import requests
url = "https://api.apollo.io/v1/accounts/bulk_update"
data = {
"api_key": "YOUR API KEY HERE",
"account_ids": ["account_id1", "account_id2"],
"account_stage_id": "stage_id"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"accounts": [
{
"id": "5c3d15XXXXXXXXXXXXXXXXXX",
"account_stage_id": "new_account_stage_id"
}
]
}
POST https://api.apollo.io/v1/accounts/bulk_update
Query parameters
| Parameter | Description |
|---|---|
| account_ids | An array of account ids. You can filter for a list of account IDS with the accounts/search API. |
| account_stage_id | The account stage id to change into. You can GET a list of possible stage ids and its associated information from /account_stages |
Update account ownership
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"account_ids": ["account_id1", "account_id2"],
"owner_id": "owner_id"
}' "https://api.apollo.io/v1/accounts/update_owners"
import requests
url = "https://api.apollo.io/v1/accounts/update_owners"
data = {
"api_key": "YOUR API KEY HERE",
"account_ids": ["account_id1", "account_id2"],
"owner_id": "owner_id"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"accounts": [
{
"id": "5c3d15XXXXXXXXXXXXXXXXXX",
"owner_id": "new_owner_id"
}
]
}
POST https://api.apollo.io/v1/accounts/update_owners
Query parameters
| Parameter | Description |
|---|---|
| account_ids | An array of account ids. You can filter for a list of account IDS with the accounts/search API. |
| owner_id | The owner id to change into. You can GET a list of possible users and its associated information from /users |
Sequences API
Use the sequences API to interact with sequences, add contacts to sequence, and more!
Search for sequences
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"q_name": "Sequence Name"
}' "https://api.apollo.io/v1/emailer_campaigns/search"
import requests
url = "https://api.apollo.io/v1/emailer_campaigns/search"
data = {
"api_key": "YOUR API KEY HERE",
"q_name": "Sequence Name"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"pagination": {
"page": 1,
"per_page": 25,
"total_entries": 1,
"total_pages": 1
},
"breadcrumbs": [
{
"label": "Name",
"signal_field_name": "q_name",
"value": "Manual Message Sequence",
"display_name": "Manual Message Sequence"
}
],
"emailer_campaigns": [
{
"id": "5c8751XXXXXXXXXXXXXXXX",
"name": "Manual Message Sequence",
"archived": false,
"created_at": "2019-03-12T06:27:23.539Z",
"emailer_schedule_id": "5c1004XXXXXXXXXXXXXXXXXX",
"max_emails_per_day": null,
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"same_account_reply_policy_cd": null,
"excluded_account_stage_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"excluded_contact_stage_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"contact_email_event_to_stage_mapping": {},
"label_ids": [],
"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": [],
"mark_finished_if_reply": true,
"mark_finished_if_interested": true,
"mark_paused_if_ooo": true,
"sequence_by_exact_daytime": null,
"permissions": "team_can_view",
"last_used_at": "2020-04-07T00:34:36.244+00:00",
"sequence_ruleset_id": "5c1004a041f5ac0995d5f61f",
"folder_id": null,
"same_account_reply_delay_days": 30,
"num_steps": 1,
"unique_scheduled": 0,
"unique_delivered": 1,
"unique_bounced": 0,
"unique_opened": 1,
"unique_replied": 0,
"unique_demoed": 0,
"unique_clicked": 0,
"unique_unsubscribed": 0,
"bounce_rate": 0,
"open_rate": 1,
"click_rate": 0,
"reply_rate": 0,
"spam_blocked_rate": 0,
"opt_out_rate": 0,
"demo_rate": 0,
"loaded_stats": true,
"cc_emails": "",
"bcc_emails": ""
}
],
"num_fetch_result": null
}
This feature is not accessible to Apollo users on free plans.
POST https://api.apollo.io/v1/emailer_campaigns/search
| Parameter | Description | Example |
|---|---|---|
| q_name | Name | "Name of Sequence" |
Add contacts to sequence
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"async": false,
"contact_ids": ["contact id 1", "contact id 2"],
"emailer_campaign_id": REPLACE_WITH_SEQUENCE_ID,
"send_email_from_email_account_id": "email_account_id",
"sequence_active_in_other_campaigns": false,
"sequence_no_email": false,
"sequence_finished_in_other_campaigns": false,
"sequence_unverified_email": false,
"sequence_job_change": false,
"sequence_same_company_in_same_campaign": false,
"user_id": "5cc77dXXXXXXXXXXXXXXXXXX"
}' "https://api.apollo.io/v1/emailer_campaigns/REPLACE_WITH_SEQUENCE_ID/add_contact_ids"
import requests
url = "https://api.apollo.io/v1/emailer_campaigns/REPLACE_WITH_SEQUENCE_ID/add_contact_ids"
data = {
"api_key": "YOUR API KEY HERE",
"async": False,
"contact_ids": ["contact id 1", "contact id 2"],
"emailer_campaign_id": REPLACE_WITH_SEQUENCE_ID,
"send_email_from_email_account_id": "email_account_id",
"sequence_active_in_other_campaigns": False,
"sequence_no_email": False,
"sequence_finished_in_other_campaigns": False,
"sequence_unverified_email": False,
"sequence_job_change": False,
"sequence_same_company_in_same_campaign": False
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contacts": [
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"first_name": "Ray",
"last_name": "Li",
"name": "Ray Li",
"linkedin_url": null,
"title": "CTO",
"contact_stage_id": "5c1004XXXXXXXXXXXXXXXXXX",
"owner_id": "5c1004XXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Apollo",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0.0,
"salesforce_id": "0036g000XXXXXXX",
"salesforce_lead_id": null,
"salesforce_contact_id": "0036g0000XXXXXXXXX",
"salesforce_account_id": "0016g0000XXXXXXXXX",
"salesforce_owner_id": "0056g000000XXXXXXXXX",
"created_at": "2020-07-27T01:23:36.898Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [
"5c1004XXXXXXXXXXXXXXXXXX"
],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": "5c1004XXXXXXXXXXXXXXXXXX",
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": "+165XXXXXX",
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-07-27T01:23:36.898Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "ray@apollo.io",
"salesforce_record_url": "https://na174.salesforce.com/0036g00000XXXXXXX",
"contact_campaign_statuses": [
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"emailer_campaign_id": "5c1004XXXXXXXXXXXXXXXXXX",
"send_email_from_user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"inactive_reason": "Sequence inactive",
"status": "paused",
"added_at": "2020-08-26T17:53:02.533+00:00",
"added_by_user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"finished_at": null,
"paused_at": null,
"auto_unpause_at": null,
"send_email_from_email_address": "ab@apollo.io",
"send_email_from_email_account_id": "5c1004XXXXXXXXXXXXXXXXXX",
"manually_set_unpause": null,
"failure_reason": null,
"current_step_id": null,
"current_step_position": null
}
],
"phone_numbers": [
],
"account_phone_note": null
}
],
"emailer_campaign": {
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"name": "Test Sequence",
"archived": false,
"created_at": "2020-08-26T09:21:01.510Z",
"emailer_schedule_id": "5c1004XXXXXXXXXXXXXXXXXX",
"max_emails_per_day": null,
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"same_account_reply_policy_cd": null,
"excluded_account_stage_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"excluded_contact_stage_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"contact_email_event_to_stage_mapping": {},
"label_ids": [],
"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": [],
"mark_finished_if_reply": true,
"mark_finished_if_interested": true,
"mark_paused_if_ooo": true,
"sequence_by_exact_daytime": null,
"permissions": "",
"last_used_at": "2020-08-26T17:53:02.672+00:00",
"sequence_ruleset_id": "5c1004XXXXXXXXXXXXXXXXXX",
"folder_id": null,
"same_account_reply_delay_days": 30,
"unique_scheduled": "loading",
"unique_delivered": 0,
"unique_bounced": 0,
"unique_opened": 0,
"unique_replied": 0,
"unique_demoed": 0,
"unique_clicked": 0,
"unique_unsubscribed": 0,
"bounce_rate": 0.0,
"open_rate": 0.0,
"click_rate": 0.0,
"reply_rate": 0.0,
"spam_blocked_rate": 0.0,
"opt_out_rate": 0.0,
"demo_rate": 0.0,
"loaded_stats": true,
"contact_statuses": {
"active": "loading",
"failed": "loading",
"paused": "loading",
"finished": "loading",
"bounced": "loading",
"not_sent": "loading"
},
"num_contacts": 1,
"cc_emails": "",
"bcc_emails": ""
},
"emailer_steps": [],
"emailer_touches": [],
"team": {
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"sequences_finder_empty": false
}
}
POST https://api.apollo.io/v1/emailer_campaigns/REPLACE_WITH_SEQUENCE_ID/add_contact_ids
| Parameter | Description | Example |
|---|---|---|
| id (required, embedded in URL) | ID of the sequence | "583f2f7ed9ced98ab5bfXXXX" |
| contact_ids (required) | An array of contact Ids | ["583f2f7ed9ced98ab5bfXXXX", "583f2f7ed9ced98ab5bfXXXX"] |
| emailer_campaign_id (required) | The ID of sequence to deploy to | "583f2f7ed9ced98ab5bfXXXX" |
| send_email_from_email_account_id (required) | ID of the email account to send email from, use the email_account/search api to figure out the list IDs | "583f2f7ed9ced98ab5bfXXXX" |
| sequence_no_email | Whether to still sequence the contact if he/she does not have an email address | true or false (default false) |
| sequence_unverified_email | Whether to still sequence the contact if he/she has unverified email | true or false (default false) |
| sequence_job_change | Whether to still sequence the contact if he/she has recent job change (Note: Your plan should have job-change alerts for this to work) | true or false (default false) |
| sequence_active_in_other_campaigns | Whether to still sequence the contact if he/she is active or paused in another sequence | true or false (default false) |
| sequence_finished_in_other_campaigns | Whether to still sequence the contact if he/she already finished another sequence | true or false (default false) |
| sequence_same_company_in_same_campaign | Whether to still sequence contacts who works at the same company (Note: You should have this feature enabled for this to work) | true or false (default false) |
| async | Whether process should be executed synchronously or asynchronously | true or false (default false) |
| user_id | User who is performing this action | 5cc77dXXXXXXXXXXXXXXXXXX |
Remove contacts from sequence / marking contacts as finished in sequence
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"emailer_campaign_ids": ["contact id 1", "contact id 2"],
"contact_ids": ["contact id 1", "contact id 2"],
"mode": "remove",
"async": "false"
}' "https://api.apollo.io/v1/emailer_campaigns/remove_or_stop_contact_ids"
import requests
url = "https://api.apollo.io/v1/emailer_campaigns/remove_or_stop_contact_ids"
data = {
"api_key": "YOUR API KEY HERE",
"emailer_campaign_ids": ["contact id 1", "contact id 2"],
"contact_ids": ["contact id 1", "contact id 2"],
"mode": "remove",
"async": False
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
"contacts": [
{
"id": "5f0d9de3XXXXXXXXXXXXXXXXXX",
"first_name": "Jon",
"last_name": "Snow",
"name": "Jon Snow",
"linkedin_url": null,
"title": null,
"contact_stage_id": "5f0d9d5aXXXXXXXXXXXXXXXXXX",
"owner_id": "5f0d9d5XXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": "Winter",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": null,
"linkedin_uid": null,
"extrapolated_email_confidence": 0.0,
"salesforce_id": null,
"salesforce_lead_id": null,
"salesforce_contact_id": null,
"salesforce_account_id": null,
"salesforce_owner_id": null,
"created_at": "2020-07-14T11:58:27.395Z",
"lead_request_id": null,
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": null,
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": null,
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-07-14T11:58:27.395Z",
"queued_for_crm_push": false,
"starred_by_user_ids": [],
"suggested_from_rule_engine_config_id": null,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "jonsnow@westeros.com",
"contact_campaign_statuses": [],
"phone_numbers": [],
"account_phone_note": null
}
],
"emailer_campaigns": [
{
"id": "5f46297XXXXXXXXXXXXXXXXXX"
}
],
"num_contacts": 0,
"contact_statuses": {
"active": "loading",
"failed": "loading",
"paused": "loading",
"finished": "loading",
"bounced": "loading",
"not_sent": "loading"
},
"emailer_steps": []
}
POST https://api.apollo.io/v1/emailer_campaigns/remove_or_stop_contact_ids
| Parameter | Description | Example |
|---|---|---|
| emailer_campaign_ids (required) | A list of ids to remove all contacts from | ["583f2f7ed9ced98ab5bfXXXX", "583f2f7ed9ced98ab5bfXXXX"] |
| contact_ids (required) | An array of contact Ids to remove from the sequences | ["583f2f7ed9ced98ab5bfXXXX", "583f2f7ed9ced98ab5bfXXXX"] |
| mode (required) | Whether to remove the contacts from the sequence, or mark them as finished or stop them | mark_as_finished OR remove OR stop |
Tasks API
A task is an action to be performed on a contact, The task can be assigned to any member of your team and also given the appropriate priority
Creating a task
Sample request:
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"priority": "medium",
"user_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"due_at": "2020-12-21T16:16:48.311Z",
"type": "call",
"contact_ids": [
"5cd9XXXXXXXXXXXXXXXXXXXX",
"5cd9XXXXXXXXXXXXXXXXXXXX"
],
"note": "Note to be attached to the task",
"status": "scheduled"
}' "https://api.apollo.io/v1/tasks/bulk_create"
import requests
url = "https://api.apollo.io/v1/tasks/bulk_create"
data = {
"api_key": "YOUR API KEY HERE",
"priority": "medium",
"user_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"due_at": "2020-12-21T16:16:48.311Z",
"type": "call",
"contact_ids": [
"5cd9XXXXXXXXXXXXXXXXXXXX",
"5cd9XXXXXXXXXXXXXXXXXXXX"
],
"note": "Note to be attached to the task",
"status": "scheduled"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=data)
print(response.text)
Sample response:
{
true
}
POST https://api.apollo.io/v1/tasks/bulk_create
| Parameter | Description | Example |
|---|---|---|
| priority (required) | Priority of the task | "high"/"medium"/"low" |
| user_id | The ID of the user the task is to be assigned to . You can GET a list of possible users from misc/users | "583f2f7ed9ced98ab5bfXXXX" |
| due_at | the due date and time for the task | 2020-12-21T16:16:48.311Z |
| type | The type of the task there are 3 valid task types call, outreach_manual_email ,action_item |
call, outreach_manual_email ,action_item |
| contact_ids (required) | An array of contact Ids | ["583f2f7ed9ced98ab5bfXXXX", "583f2f7ed9ced98ab5bfXXXX"] |
| note | note to be attached to the task | "Example note" |
| status | the status of the task | "scheduled" |
Getting a list of tasks
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"api_key": "YOUR API KEY HERE",
"sort_by_field": "task_created_at",
"per_page": 200,
"open_factor_names": [
"task_types"
]
}' "https://api.apollo.io/v1/tasks/search"
import requests
url = "https://api.apollo.io/v1/tasks/search"
querystring = {
"api_key": "YOUR API KEY HERE",
"sort_by_field": "task_created_at",
"open_factor_names": [
"task_types"
]
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"tasks": [
{
"emailer_campaign_id": null,
"id": "5ff3XXXXXXXXXXXXXXXXXXXX",
"user_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2021-01-04T15:48:10.467Z",
"completed_at": null,
"note": null,
"skipped_at": null,
"due_at": "2021-01-04T15:46:48.361+00:00",
"type": "action_item",
"priority": "medium",
"status": "scheduled",
"answered": null,
"contact_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"person_id": null,
"account_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"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,
"account": {
"id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"domain": ".com",
"name": "google",
"team_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": null,
"source": "salesforce",
"original_source": "salesforce",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2020-12-09T21:41:51.657Z",
"phone": "(800) 424-9299",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011U0XXXXXXXXXXXX",
"crm_owner_id": "0051U0XXXXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+180xxxxxxxx",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011U0XXXXXXXXXXXX",
"persona_counts": {}
},
"contact": {
"id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"linkedin_url": null,
"title": "Senior QA Specialist",
"contact_stage_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": null,
"source": "salesforce_contact",
"original_source": "salesforce_contact",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": "Washington, District of Columbia, United States",
"linkedin_uid": null,
"extrapolated_email_confidence": 0.0,
"salesforce_id": "0031U0XXXXXXXXXXXX",
"salesforce_lead_id": null,
"salesforce_contact_id": "0031U0XXXXXXXXXXXX",
"salesforce_account_id": "0011U0XXXXXXXXXXXX",
"crm_owner_id": "0051U0XXXXXXXXXXXX",
"created_at": "2020-12-09T21:41:57.503Z",
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": "+180xxxxxxxx",
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-12-28T10:51:37.432Z",
"queued_for_crm_push": false,
"suggested_from_rule_engine_config_id": null,
"email_unsubscribed": false,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "email@domain.io",
"salesforce_record_url": "https://na85.salesforce.com/0031U0XXXXXXXXXXXX",
"outreach_id": "1X7",
"outreach_url": "https://app2a.outreach.io/prospects/XXX/overview",
"salesloft_id": "6XX1XX5X",
"salesloft_url": "https://app.salesloft.com/app/people/6XXXXXXX",
"phone_numbers": [
{
"raw_number": "(X00) 4X4-XXXX",
"sanitized_number": "+280XXXXXXXX",
"type": "other",
"position": 0,
"status": "no_status"
}
],
"account_phone_note": null
}
}
{
"emailer_campaign_id": null,
"id": "5ff3XXXXXXXXXXXXXXXXXXXX",
"user_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2021-01-04T15:36:09.033Z",
"completed_at": null,
"note": "Call Contact",
"skipped_at": null,
"due_at": "2021-01-04T15:35:58.054+00:00",
"type": "call",
"priority": "medium",
"status": "scheduled",
"answered": null,
"contact_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"person_id": null,
"account_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"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,
"account": {
"id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"domain": "apple.com",
"name": "Apple",
"team_id": "5fcXXXXXXXXXXXXXXXXXXXX",
"typed_custom_fields": {},
"organization_id": null,
"account_stage_id": null,
"source": "salesforce",
"original_source": "salesforce",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"created_at": "2020-12-09T21:41:51.657Z",
"phone": "(X00) 4X4-XXXX",
"phone_status": "no_status",
"test_predictive_score": null,
"hubspot_id": null,
"salesforce_id": "0011U0XXXXXXXXXXXX",
"crm_owner_id": "0051U0XXXXXXXXXXXX",
"parent_account_id": null,
"sanitized_phone": "+3X0042XXXXX",
"account_playbook_statuses": [],
"existence_level": "full",
"label_ids": [],
"modality": "account",
"salesforce_record_url": "https://na85.salesforce.com/0011U0XXXXXXXXXXXX",
"persona_counts": {}
},
"contact": {
"id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"first_name": "Jane",
"last_name": "doe",
"name": "Jane Doe",
"linkedin_url": null,
"title": "Senior Engineer",
"contact_stage_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"owner_id": "5fc6XXXXXXXXXXXXXXXXXXXX",
"person_id": null,
"email_needs_tickling": false,
"organization_name": null,
"source": "salesforce_contact",
"original_source": "salesforce_contact",
"organization_id": null,
"headline": null,
"photo_url": null,
"present_raw_address": "Washington, District of Columbia, United States",
"linkedin_uid": null,
"extrapolated_email_confidence": 0.0,
"salesforce_id": "003XXXXXXXXXXXXXXX",
"salesforce_lead_id": null,
"salesforce_contact_id": "0031XXXXXXXxXXXXX",
"salesforce_account_id": "0011U00XXXXXXxXXX",
"crm_owner_id": "0051U0XXXXXXXXXXXX",
"created_at": "2020-12-09T21:41:57.503Z",
"test_predictive_score": null,
"emailer_campaign_ids": [],
"email_manually_changed": false,
"direct_dial_status": null,
"direct_dial_enrichment_failed_at": null,
"email_status": "verified",
"account_id": "5fd1XXXXXXXXXXXXXXXXXXXX",
"last_activity_date": null,
"hubspot_vid": null,
"hubspot_company_id": null,
"sanitized_phone": "+18XXXXXXXXX",
"merged_crm_ids": [],
"typed_custom_fields": {},
"updated_at": "2020-12-28T10:51:37.432Z",
"queued_for_crm_push": false,
"suggested_from_rule_engine_config_id": null,
"email_unsubscribed": false,
"label_ids": [],
"has_pending_email_arcgate_request": false,
"has_email_arcgate_request": false,
"existence_level": "full",
"email": "jane.doe@apple.com",
"salesforce_record_url": "https://naXX.salesforce.com/0031U00XXXXXXXXXXXX",
"outreach_id": "4XX",
"outreach_url": "https://app2a.outreach.io/prospects/4XX/overview",
"salesloft_id": "62619350",
"salesloft_url": "https://app.salesloft.com/app/people/62XXXXXX",
"phone_numbers": [
{
"raw_number": "(8XX) 4X4-XXXX",
"sanitized_number": "+1X004XXXXXX",
"type": "other",
"position": 0,
"status": "no_status"
}
],
"account_phone_note": null
}
}
],
"breadcrumbs": [],
"pagination": {
"page": 1,
"per_page": 2,
"total_entries": 20,
"total_pages": 7
},
"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": [],
"linkedin_specialty_facets": [],
"angellist_market_facets": [],
"linkedin_company_size_facets": [],
"num_employees_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": [],
"person_city_facets": [],
"person_state_facets": [],
"person_country_facets": [],
"organization_hq_city_facets": [],
"organization_hq_state_facets": [],
"organization_hq_country_facets": [],
"task_types": [
{
"value": "contact_call",
"display_name": "Call Contact",
"count": 14
},
{
"value": "outreach_manual_email",
"display_name": "Email Contact",
"count": 5
},
{
"value": "contact_action_item",
"display_name": "Contact Action Item",
"count": 1
}
],
"total_facets": [
{
"value": "pipeline_total",
"display_name": "Total",
"count": 20
}
]
},
"pipeline_total": 20,
"num_fetch_result": null
}
This feature is not accessible to Apollo users on free plans.
GET https://api.apollo.io/v1/tasks/search
| Parameter | Description | Example |
|---|---|---|
| open_factor_names (required) | This is a required field and must be passed in with the request | ["task_types"] |
Misc
Get a list of users
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/users/search?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/users/search"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"pagination": {
"page": null,
"per_page": 25,
"total_entries": 2,
"total_pages": 1
},
"users": [
{
"id": "5cc77dXXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"first_name": "Test",
"last_name": "User",
"title": null,
"email": "alangrios14@gmail.com",
"created_at": "2019-04-29T22:39:36.645Z",
"credit_limit": 50,
"direct_dial_credit_limit": 0,
"salesforce_account": null,
"deleted": false,
"should_include_unsubscribe_link": false,
"opt_out_html_template": "If you don't want to hear from me again, please <%let me know%>.",
"name": "Test User",
"enable_click_tracking": false,
"password_needs_reset": false,
"salesforce_id": null,
"default_cockpit_layout": null,
"default_finder_view_ids": {},
"default_account_overview_layout_id": null,
"default_organization_overview_layout_id": null,
"default_contact_overview_layout_id": null,
"bridge_calls": false,
"bridge_phone_number": null,
"bridge_incoming_calls": false,
"bridge_incoming_phone_number": null,
"current_email_verified": true,
"record_calls": true,
"salesforce_instance_url": null,
"permission_set_id": "5c1004XXXXXXXXXXXXXXXXXX",
"assistant_setting": {
"_id": "5cc77dXXXXXXXXXXXXXXXXXX",
"deal_size_metric": "amount",
"inactive_account_stage_ids": [],
"inactive_contact_stage_ids": [],
"insight_deal_size_signals": {},
"insight_sale_cycle_signals": {},
"insight_win_rate_signals": {},
"job_posting_locations": [],
"job_posting_titles": [],
"latest_funding_days": 90,
"latest_news_days": 30,
"max_num_active_accounts": 100,
"max_people_in_sequence_per_account": 5,
"num_inactive_days_to_re_engage": 180,
"persona_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"success_case_account_stage_ids": [],
"technology_uids": [],
"territory_company_size_ranges": [],
"territory_location_override": false,
"territory_locations": [
"United States"
],
"territory_person_locations": [
"United States"
],
"id": "5cc77dXXXXXXXXXXXXXXXXXX",
"key": "5cc77XXXXXXXXXXXXXXXXXX"
},
"typed_custom_fields": {},
"default_use_local_numbers": false,
"disable_email_linking": null,
"sync_salesforce_id": null,
"sync_crm_id": null,
"zp_contact_id": "59f9e0XXXXXXXXXXXXXXXXXX",
"chrome_extension_downloaded": false,
"user_roles": [],
"email_oauth_signin_only": false,
"notification_last_created_at": "2020-04-07T00:40:12.399+00:00",
"crm_requested_to_integrate": null,
"has_invited_user": false,
"notification_last_read_at": null,
"daily_data_request_email": false,
"data_request_emails": true,
"daily_task_email": true,
"free_data_credits_email": true,
"dismiss_new_team_suggestion": null,
"request_email_change_to": null,
"self_identified_persona": "Product",
"added_contact_to_sequence": false,
"has_approved_emailer_campaign": false,
"main_emailer_campaign_id": null,
"current_onboarding_step": "create_account",
"onboarding_use_cases": {
"bulk_status": "started",
"current_use_case": "bulk",
"first_user_case": "bulk",
"searched_people": true,
"download_leads": true
},
"skip_use_case_selection": false,
"subteam_ids": [
"5cc77XXXXXXXXXXXXXXXXXX"
],
"prospect_territory_ids": [],
"linked_salesforce": null,
"linked_hubspot": false,
"linked_salesloft": false,
"default_chrome_extension_log_email_send_to_salesforce": true,
"chrome_extension_auto_match_salesforce_opportunity": true,
"chrome_extension_gmail_enable_email_tools": true,
"enable_desktop_notifications": true,
"default_chrome_extension_enable_reminders": false,
"chrome_extension_gmail_enable_crm_sidebar": true
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"first_name": "Alan",
"last_name": "Rios",
"title": null,
"email": "example@domain.io",
"created_at": "2018-12-11T18:40:32.639Z",
"credit_limit": 50,
"direct_dial_credit_limit": 0,
"salesforce_account": "fencefeet@gmail.com",
"deleted": false,
"should_include_unsubscribe_link": false,
"opt_out_html_template": "If you don't want to hear from me again, please <%let me know%>.",
"name": "Alan Rios",
"enable_click_tracking": true,
"password_needs_reset": false,
"salesforce_id": "0051XXXXXXXXXXXXXX",
"default_cockpit_layout": "5c1004XXXXXXXXXXXXXXXXXX",
"default_finder_view_ids": {},
"default_account_overview_layout_id": null,
"default_organization_overview_layout_id": null,
"default_contact_overview_layout_id": null,
"bridge_calls": false,
"bridge_phone_number": null,
"bridge_incoming_calls": false,
"bridge_incoming_phone_number": "+1 (408) 201-2216",
"current_email_verified": true,
"record_calls": true,
"salesforce_instance_url": "https://na85.salesforce.com",
"permission_set_id": "5c1004XXXXXXXXXXXXXXXXXX",
"assistant_setting": {
"_id": "5c1004XXXXXXXXXXXXXXXXXX",
"deal_size_metric": "amount",
"inactive_account_stage_ids": [],
"inactive_contact_stage_ids": [],
"insight_deal_size_signals": {},
"insight_sale_cycle_signals": {},
"insight_win_rate_signals": {},
"job_posting_locations": [],
"job_posting_titles": [],
"latest_funding_days": 90,
"latest_news_days": 30,
"max_num_active_accounts": 100,
"max_people_in_sequence_per_account": 5,
"num_inactive_days_to_re_engage": 180,
"persona_ids": [
"5c1004XXXXXXXXXXXXXXXXXX",
"5c1004XXXXXXXXXXXXXXXXXX"
],
"success_case_account_stage_ids": [],
"technology_uids": [],
"territory_company_size_ranges": [],
"territory_location_override": false,
"territory_locations": [
"United States"
],
"territory_person_locations": [
"United States"
],
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"key": "5c1004XXXXXXXXXXXXXXXXXX"
},
"typed_custom_fields": {},
"default_use_local_numbers": false,
"disable_email_linking": null,
"sync_salesforce_id": "0051UXXXXXXXXXXXXXX",
"sync_crm_id": null,
"zp_contact_id": "5a9de5XXXXXXXXXXXXXXXXXX",
"chrome_extension_downloaded": true,
"user_roles": [
"admin"
],
"email_oauth_signin_only": false,
"notification_last_created_at": "2019-11-06T22:48:12.812+00:00",
"crm_requested_to_integrate": null,
"has_invited_user": false,
"notification_last_read_at": "2019-09-25T18:09:05.000+00:00",
"daily_data_request_email": true,
"data_request_emails": true,
"daily_task_email": true,
"free_data_credits_email": true,
"dismiss_new_team_suggestion": true,
"request_email_change_to": null,
"self_identified_persona": null,
"subteam_ids": [],
"prospect_territory_ids": [],
"linked_salesforce": true,
"linked_hubspot": false,
"linked_salesloft": true,
"default_chrome_extension_log_email_send_to_salesforce": true,
"chrome_extension_auto_match_salesforce_opportunity": true,
"chrome_extension_gmail_enable_email_tools": true,
"enable_desktop_notifications": true,
"default_chrome_extension_enable_reminders": false,
"chrome_extension_gmail_enable_crm_sidebar": true
}
],
"num_fetch_result": null
}
This feature is not accessible to Apollo users on free plans.
GET https://api.apollo.io/v1/users/search
Get a list of email accounts
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/email_accounts?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/email_accounts"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"email_accounts": [
{
"aliases": [
"alan@apollo.io"
],
"id": "5a298fXXXXXXXXXXXXXXXXXX",
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"email": "example@random.io",
"type": "gmail",
"active": true,
"default": true,
"seconds_delay_between_emails": 0,
"provider_display_name": "Gmail",
"nylas_provider": null,
"last_synced_at": "2020-08-18T06:28:04.028+00:00",
"email_sending_policy_cd": "default",
"sendgrid_api_user": null,
"mailgun_domains": null,
"signature_edit_disabled": true,
"email_daily_threshold": 100,
"max_outbound_emails_per_hour": 50,
"signature_html": "null"
}
]
}
GET https://api.apollo.io/v1/email_accounts
Get a list of all lists/tags
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/labels?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/labels"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
[
{
"_id": "5f21ccXXXXXXXXXXXXXXXXXX",
"cached_count": 5,
"created_at": "2020-07-29T19:23:14.220Z",
"modality": "contacts",
"name": "test API label",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"updated_at": "2020-08-04T18:16:32.733Z",
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"id": "5f21ccXXXXXXXXXXXXXXXXXX",
"key": "5f21ccXXXXXXXXXXXXXXXXXX"
},
{
"_id": "5dc34dXXXXXXXXXXXXXXXXXX",
"cached_count": 0,
"created_at": "2019-11-06T22:48:53.173Z",
"modality": "contacts",
"name": "Test",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"updated_at": "2020-07-29T19:23:14.308Z",
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"id": "5dc34dXXXXXXXXXXXXXXXXXX",
"key": "5dc34dXXXXXXXXXXXXXXXXXX"
},
{
"_id": "5cd9eeXXXXXXXXXXXXXXXXXX",
"cached_count": 3001,
"created_at": "2019-05-13T22:22:30.843Z",
"modality": "contacts",
"name": "Test List 1000 Net New Contacts",
"team_id": "5c1004XXXXXXXXXXXXXXXXXX",
"updated_at": "2019-05-13T23:38:49.323Z",
"user_id": "5c1004XXXXXXXXXXXXXXXXXX",
"id": "5cd9eeXXXXXXXXXXXXXXXXXX",
"key": "5cd9eeXXXXXXXXXXXXXXXXXX"
}
]
GET https://api.apollo.io/v1/labels
Get a list of all custom fields
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/typed_custom_fields?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/typed_custom_fields"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"typed_custom_fields": [
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"modality": "opportunity",
"name": "Lead Source",
"type": "picklist",
"picklist_options": [],
"mapped_crm_field": "LeadSource",
"additional_mapped_crm_field": null,
"is_readonly_mapped_crm_field": false,
"picklist_options_last_synced_at": "2020-08-17T08:56:24.973+00:00",
"picklist_value_set_id": "5c1004XXXXXXXXXXXXXXXXXX",
"mirrored": false,
"system_name": "lead_source",
"text_field_max_length": null,
"picklist_values": [
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Web"
},
"name": "Web",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Phone Inquiry"
},
"name": "Phone Inquiry",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Partner Referral"
},
"name": "Partner Referral",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Purchased List"
},
"name": "Purchased List",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Other"
},
"name": "Other",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
}
]
},
{
"id": "5c1004XXXXXXXXXXXXXXXXXX",
"modality": "opportunity",
"name": "Type",
"type": "picklist",
"picklist_options": [],
"mapped_crm_field": "Type",
"additional_mapped_crm_field": null,
"is_readonly_mapped_crm_field": false,
"picklist_options_last_synced_at": "2020-08-17T08:56:24.975+00:00",
"picklist_value_set_id": "5c1004XXXXXXXXXXXXXXXXXX",
"mirrored": false,
"system_name": "type",
"text_field_max_length": null,
"picklist_values": [
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Existing Customer - Upgrade"
},
"name": "Existing Customer - Upgrade",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Existing Customer - Replacement"
},
"name": "Existing Customer - Replacement",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "Existing Customer - Downgrade"
},
"name": "Existing Customer - Downgrade",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
},
{
"_id": "5c1422XXXXXXXXXXXXXXXXXX",
"mapped_crm_values": {
"5c1004XXXXXXXXXXXXXXXXXX": "New Customer"
},
"name": "New Customer",
"id": "5c1422XXXXXXXXXXXXXXXXXX",
"key": "5c1422XXXXXXXXXXXXXXXXXX"
}
]
},
{
"id": "5c8bdaXXXXXXXXXXXXXXXXXX",
"modality": "contact",
"name": "User Lookup",
"type": "lookup_user",
"picklist_options": [],
"mapped_crm_field": "User_Lookup__c",
"additional_mapped_crm_field": null,
"is_readonly_mapped_crm_field": false,
"picklist_options_last_synced_at": "2019-03-15T17:00:14.000+00:00",
"picklist_value_set_id": null,
"mirrored": false,
"system_name": null,
"text_field_max_length": null
},
{
"id": "5c4f9XXXXXXXXXXXXXXXXXX",
"modality": "contact",
"name": "Custom list",
"type": "string",
"picklist_options": [],
"mapped_crm_field": "Custom_List__c",
"additional_mapped_crm_field": null,
"is_readonly_mapped_crm_field": false,
"picklist_options_last_synced_at": "2019-01-29T00:21:38.000+00:00",
"picklist_value_set_id": null,
"mirrored": false,
"system_name": null,
"text_field_max_length": null
},
{
"id": "5d856XXXXXXXXXXXXXXXXXX",
"modality": "contact",
"name": "Full Name Formula Field",
"type": "string",
"picklist_options": [],
"mapped_crm_field": "Name",
"additional_mapped_crm_field": "Name",
"is_readonly_mapped_crm_field": true,
"picklist_options_last_synced_at": "2019-09-21T00:28:11.000+00:00",
"picklist_value_set_id": null,
"mirrored": false,
"system_name": null,
"text_field_max_length": null
},
{
"id": "5e5849XXXXXXXXXXXXXXXXXX",
"modality": "contact",
"name": "Read-only field",
"type": "string",
"picklist_options": [],
"mapped_crm_field": "AssistantName",
"additional_mapped_crm_field": null,
"is_readonly_mapped_crm_field": true,
"picklist_options_last_synced_at": "2020-02-27T22:59:50.000+00:00",
"picklist_value_set_id": null,
"mirrored": false,
"system_name": null,
"text_field_max_length": null
}
]
}
GET https://api.apollo.io/v1/typed_custom_fields
Get a list of opportunity stages
Sample request:
curl -X GET -H "Content-Type: application/json" -H "Cache-Control: no-cache" "https://api.apollo.io/v1/opportunity_stages?api_key=YOUR_API_KEY_HERE"
import requests
url = "https://api.apollo.io/v1/opportunity_stages"
querystring = {
"api_key": "YOUR API KEY HERE"
}
headers = {
'Cache-Control': 'no-cache',
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
Sample response:
{
"opportunity_stages": [
{
"id": "5c14XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"name": "Negotiation/Review",
"display_order": 0.0,
"forecast_category_cd": "Pipeline",
"is_won": false,
"is_closed": false,
"probability": 90.0,
"description": null,
"salesforce_id": "01XXXXXXXXXX",
"type": "Open"
},
{
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"name": "Commit",
"display_order": 2.0,
"forecast_category_cd": "Committed",
"is_won": false,
"is_closed": false,
"probability": 90.0,
"description": "Self-explanatory",
"salesforce_id": null,
"type": "Open"
},
{
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"name": "Closed Won",
"display_order": 3.0,
"forecast_category_cd": "Closed",
"is_won": true,
"is_closed": true,
"probability": 100.0,
"description": "Self-explanatory",
"salesforce_id": "01J1UXXXXXXXXXX",
"type": "Closed/Won"
},
{
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"team_id": "5c10XXXXXXXXXXXXXXXXXXXX",
"name": "Closed Lost",
"display_order": 4.0,
"forecast_category_cd": "Omitted",
"is_won": false,
"is_closed": true,
"probability": 0.0,
"description": "Self-explanatory",
"salesforce_id": "0XX1U00XXXXXXXXXAC",
"type": "Closed/Lost"
}
]
}
GET https://api.apollo.io/v1/opportunity_stages