{ "opencollection": "1.0.0", "info": { "name": "Apollo.io Enrichment API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Enrichment", "type": "folder" }, "items": [ { "info": { "name": "People Enrichment", "type": "http" }, "http": { "method": "POST", "url": "https://api.apollo.io/api/v1/people/match", "params": [ { "name": "first_name", "value": "", "type": "query", "description": "The first name of the person. This is typically used in combination with the `last_name` parameter.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`" } ] }, "docs": "## Endpoint essentials\n\n**API key access:** `api/v1/people/match` or `Master API key`\n\n**OAuth scopes:** `people_match`\n\n**Free account access:** Requires an Apollo account registered with a work email address. Paid accounts aren't affected.\n\n**Credit usage:** `1–9 credits per person` without waterfall enrichment\n\nCredits are charged only if credit-consuming data is found: 1 credit for demographics or email, plus 8 credits if a mobile phone is returned. If no credit-consuming data is found, the " }, { "info": { "name": "Bulk People Enrichment", "type": "http" }, "http": { "method": "POST", "url": "https://api.apollo.io/api/v1/people/bulk_match", "params": [ { "name": "run_waterfall_email", "value": "", "type": "query", "description": "Set to true to enable email waterfall enrichment" }, { "name": "run_waterfall_phone", "value": "", "type": "query", "description": "Set to true to enable phone waterfall enrichment" }, { "name": "reveal_personal_emails", "value": "", "type": "query", "description": "Set to `true` if you want to enrich all matched people with personal emails. This potentially consumes credits as part of your Apollo pricing plan. The default value is `false`.

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

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

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

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

Example: `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`; `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "## Endpoint essentials\n\n**API key access:** `api/v1/people/bulk_match` or `Master API key`\n\n**OAuth scopes:** `people_bulk_match`\n\n**Free account access:** Requires an Apollo account registered with a work email address. Paid accounts aren't affected.\n\n**Credit usage:** `1–9 credits per person` without waterfall enrichment\n\nCredits are charged only if credit-consuming data is found: 1 credit for demographics or email, plus 8 credits if a mobile phone is returned. If no credit-consuming data is f" }, { "info": { "name": "Organization Enrichment", "type": "http" }, "http": { "method": "GET", "url": "https://api.apollo.io/api/v1/organizations/enrich", "params": [ { "name": "domain", "value": "", "type": "query", "description": "The domain of the company that you want to enrich. Do not include `www.`, the `@` symbol, or similar.

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

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

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

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

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

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

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

Example: `http://www.apollo.io`" } ] }, "docs": "## Endpoint essentials\n\n**API key access:** `api/v1/organizations/enrich` or `Master API key`\n\n**OAuth scopes:** `organizations_enrich`\n\n**Free account access:** Requires an Apollo account registered with a work email address. Paid accounts aren't affected.\n\n**Credit usage:** `1 credit per organization` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\n" }, { "info": { "name": "Bulk Organization Enrichment", "type": "http" }, "http": { "method": "POST", "url": "https://api.apollo.io/api/v1/organizations/bulk_enrich", "params": [ { "name": "domains[]", "value": "", "type": "query", "description": "The domain of each company that you want to enrich. Do not include `www.`, the `@` symbol, or similar.

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

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

Example: `apollo.io` and `microsoft.com`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "## Endpoint essentials\n\n**API key access:** `api/v1/organizations/bulk_enrich` or `Master API key`\n\n**OAuth scopes:** `organizations_bulk_enrich`\n\n**Free account access:** Requires an Apollo account registered with a work email address. Paid accounts aren't affected.\n\n**Credit usage:** `1 credit per organization` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\n