Apollo (API Key)
Catalog 暂无描述。
认证方式
| 方式 | 底层类型 | 状态 | 说明 |
|---|---|---|---|
| API Key | api_key | available | — |
| OAuth 2.0 | oauth2 | available | — |
调用示例
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "APOLLO_ABORT_SEQUENCE", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("APOLLO_ABORT_SEQUENCE", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute APOLLO_ABORT_SEQUENCE --data '{ }'Tool 目录
可用 Tools
71 个可调用操作
Deactivate a SequenceAPOLLO_ABORT_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Deactivate a Sequence endpoint to stop an active sequence. Once deactivated, the sequence pauses all contacts and stops sending emails.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Deactivate a Sequence endpoint to stop an active sequence. Once deactivated, the sequence pauses all contacts and stops sending emails.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Add Contacts to a SequenceAPOLLO_ADD_CONTACTS_TO_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Add Contacts to a Sequence endpoint to add contacts to the existing sequences in your team's Apollo account.<br><br>A contact is a person that your team has explicitly added to your database. Only contacts can be added to sequences. To enrich a person's data, call the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment endpoint</a>. Then, to add the person as a contact in your database, call the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Add Contacts to a Sequence endpoint to add contacts to the existing sequences in your team's Apollo account.<br><br>A contact is a person that your team has explicitly added to your database. Only contacts can be added to sequences. To enrich a person's data, call the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment endpoint</a>. Then, to add the person as a contact in your database, call the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Activate a SequenceAPOLLO_APPROVE_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Activate a Sequence endpoint to start an inactive sequence. Once activated, the sequence begins sending emails to its contacts on the configured schedule. The sequence must have at least one step configured before it can be activated.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Activate a Sequence endpoint to start an inactive sequence. Once activated, the sequence begins sending emails to its contacts on the configured schedule. The sequence must have at least one step configured before it can be activated.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Archive a SequenceAPOLLO_ARCHIVE_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Archive a Sequence endpoint to archive a sequence. Archiving a sequence marks it as inactive and finishes all contacts currently in the sequence. You must be the owner of the sequence or have full access sharing permissions to archive it.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Archive a Sequence endpoint to archive a sequence. Archiving a sequence marks it as inactive and finishes all contacts currently in the sequence. You must be the owner of the sequence or have full access sharing permissions to archive it.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Bulk Create AccountsAPOLLO_BULK_CREATE_ACCOUNTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the bulk create accounts endpoint to create up to one hundred accounts in a single API request. This endpoint supports intelligent deduplication and returns separate arrays for newly created and existing accounts. <br><br>**Important**: This endpoint creates new accounts but doesn't update existing ones. Existing accounts that match the criteria are returned in the <code>existing_accounts</code> array without modification. <br><br>To update existing accounts, use the <a href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update Accounts endpoint</a>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the bulk create accounts endpoint to create up to one hundred accounts in a single API request. This endpoint supports intelligent deduplication and returns separate arrays for newly created and existing accounts. <br><br>**Important**: This endpoint creates new accounts but doesn't update existing ones. Existing accounts that match the criteria are returned in the <code>existing_accounts</code> array without modification. <br><br>To update existing accounts, use the <a href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update Accounts endpoint</a>.
认证
需要 Connected AccountTags
Bulk Create ContactsAPOLLO_BULK_CREATE_CONTACTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Bulk Create Contacts endpoint to create up to 100 contacts in a single API request. This endpoint supports intelligent deduplication and returns separated arrays for newly created and existing contacts. <br><br>Important: This endpoint creates new contacts but doesn't update existing ones (except for placeholder contacts from email imports). Existing contacts that match the criteria are returned in the <code>existing_contacts</code> array without modification.<br><br>To update existing contacts, use the <a href="https://docs.apollo.io/reference/bulk-update-contacts">Bulk Update Contacts endpoint</a>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Bulk Create Contacts endpoint to create up to 100 contacts in a single API request. This endpoint supports intelligent deduplication and returns separated arrays for newly created and existing contacts. <br><br>Important: This endpoint creates new contacts but doesn't update existing ones (except for placeholder contacts from email imports). Existing contacts that match the criteria are returned in the <code>existing_contacts</code> array without modification.<br><br>To update existing contacts, use the <a href="https://docs.apollo.io/reference/bulk-update-contacts">Bulk Update Contacts endpoint</a>.
认证
需要 Connected AccountTags
Bulk Create TasksAPOLLO_BULK_CREATE_TASKSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Bulk Create Tasks endpoint to create multiple tasks in a single API request. A separate task will be created for each contact provided. <br><br>This endpoint returns a `success` boolean and a `tasks` array containing the created tasks. <br><br>Apollo doesn't apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo creates a new task instead of updating the existing task. <br><br>For creating a single task, use the <a href="https://docs.apollo.io/reference/create-a-task">Create a Task endpoint</a> instead. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Bulk Create Tasks endpoint to create multiple tasks in a single API request. A separate task will be created for each contact provided. <br><br>This endpoint returns a `success` boolean and a `tasks` array containing the created tasks. <br><br>Apollo doesn't apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo creates a new task instead of updating the existing task. <br><br>For creating a single task, use the <a href="https://docs.apollo.io/reference/create-a-task">Create a Task endpoint</a> instead. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Bulk Organization EnrichmentAPOLLO_BULK_ORGANIZATION_ENRICHMENTThis endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Bulk Organization Enrichment endpoint to enrich data for up to ten companies with a single API call. To enrich data for a single company, use the <a href="https://docs.apollo.io/reference/organization-enrichment">Organization Enrichment endpoint</a> instead.<br><br>You can identify the companies to enrich by providing a list of domains via the <code>domains[]</code> query parameter, or by providing a <code>details</code> array in the request body where each company can be matched by any combination of domain, LinkedIn URL, name, and website.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, and corporate phone numbers and locations.<br><br>This endpoint's <a href="https://docs.apollo.io/reference/rate-limits">rate limit</a> is 20/min, 100/hour, 600/day.需要连接
This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Bulk Organization Enrichment endpoint to enrich data for up to ten companies with a single API call. To enrich data for a single company, use the <a href="https://docs.apollo.io/reference/organization-enrichment">Organization Enrichment endpoint</a> instead.<br><br>You can identify the companies to enrich by providing a list of domains via the <code>domains[]</code> query parameter, or by providing a <code>details</code> array in the request body where each company can be matched by any combination of domain, LinkedIn URL, name, and website.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, and corporate phone numbers and locations.<br><br>This endpoint's <a href="https://docs.apollo.io/reference/rate-limits">rate limit</a> is 20/min, 100/hour, 600/day.
认证
需要 Connected AccountTags
Bulk People EnrichmentAPOLLO_BULK_PEOPLE_ENRICHMENTThis endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Bulk People Enrichment endpoint to enrich data for up to ten people with a single API call. To enrich data for a single person, use the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct people to enrich. When you provide more information, Apollo is more likely to find matches within its database. If you only provide general information, such as a name without a domain or email address, you may receive a `200` response, but the response indicates that no records have been enriched. The details for each person should be passed as an object with the `details[]` array.<br><br>By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers. If you set either of these parameters to `true`, Apollo attempts to provide emails or phone numbers for all matches.<br><br>You can use also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.<br><br> **Webhook Response Details:** - When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details) - When passing Waterfall flags, the webhook response follows: [Waterfall webhook response details](doc:enrich-phone-and-email-using-data-waterfall#response-details) - You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing <code>request_id</code>. **Webhook Requirements:** - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS. - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo. - **Idempotency:** Apollo may retry webhook calls. Your endpoint should be idempotent to handle duplicate payloads safely.需要连接
This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Bulk People Enrichment endpoint to enrich data for up to ten people with a single API call. To enrich data for a single person, use the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct people to enrich. When you provide more information, Apollo is more likely to find matches within its database. If you only provide general information, such as a name without a domain or email address, you may receive a `200` response, but the response indicates that no records have been enriched. The details for each person should be passed as an object with the `details[]` array.<br><br>By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers. If you set either of these parameters to `true`, Apollo attempts to provide emails or phone numbers for all matches.<br><br>You can use also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.<br><br> **Webhook Response Details:** - When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details) - When passing Waterfall flags, the webhook response follows: [Waterfall webhook response details](doc:enrich-phone-and-email-using-data-waterfall#response-details) - You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing <code>request_id</code>. **Webhook Requirements:** - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS. - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo. - **Idempotency:** Apollo may retry webhook calls. Your endpoint should be idempotent to handle duplicate payloads safely.
认证
需要 Connected AccountTags
Bulk Update AccountsAPOLLO_BULK_UPDATE_ACCOUNTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Bulk Update Accounts endpoint to simultaneously update multiple accounts in your team's Apollo account. <br><br>This endpoint allows you to update common fields across multiple accounts efficiently, such as account stages, owners, names, and custom fields. <br><br>You can update up to 1,000 accounts per request.<br><br><b>Important:</b> Asynchronous processing (async parameter) is only supported when using <code>account_ids</code> to apply the same updates to all accounts. If you use async with <code>account_attributes</code> (individual updates per account), the request fails with a 422 error.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Bulk Update Accounts endpoint to simultaneously update multiple accounts in your team's Apollo account. <br><br>This endpoint allows you to update common fields across multiple accounts efficiently, such as account stages, owners, names, and custom fields. <br><br>You can update up to 1,000 accounts per request.<br><br><b>Important:</b> Asynchronous processing (async parameter) is only supported when using <code>account_ids</code> to apply the same updates to all accounts. If you use async with <code>account_attributes</code> (individual updates per account), the request fails with a 422 error.
认证
需要 Connected AccountTags
Bulk Update ContactsAPOLLO_BULK_UPDATE_CONTACTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Bulk Update Contacts endpoint to update multiple contacts in your team's Apollo account simultaneously. <br><br>This endpoint allows you to update common fields across multiple contacts efficiently, such as contact stages, owners, custom fields, and other contact attributes. <br><br>You can update up to 1000 contacts per request; requests with more than 1000 contacts are rejected with a <code>422</code> error. Requests of 100 or fewer contacts are processed synchronously and return the updated contacts immediately. Requests of 101 to 1000 contacts are processed asynchronously. You can also force asynchronous processing at any batch size by setting the <code>async</code> parameter to <code>true</code>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Bulk Update Contacts endpoint to update multiple contacts in your team's Apollo account simultaneously. <br><br>This endpoint allows you to update common fields across multiple contacts efficiently, such as contact stages, owners, custom fields, and other contact attributes. <br><br>You can update up to 1000 contacts per request; requests with more than 1000 contacts are rejected with a <code>422</code> error. Requests of 100 or fewer contacts are processed synchronously and return the updated contacts immediately. Requests of 101 to 1000 contacts are processed asynchronously. You can also force asynchronous processing at any batch size by setting the <code>async</code> parameter to <code>true</code>.
认证
需要 Connected AccountTags
Check Email Send StatusAPOLLO_CHECK_EMAIL_SEND_STATUSUse the Check Email Send Status endpoint to check the current delivery status of an email message. This is typically used after calling the <a href="https://docs.apollo.io/reference/send-email-now" target="_blank">Send Email Now endpoint</a>, since emails are sent asynchronously and a successful send response only means the email was queued. <br><br>You must provide the `id` of the email message. The message must belong to your team, otherwise a `404` is returned. <br><br>The response always includes the message `id`, its current `status`, and a human-readable `message`. The remaining fields depend on the status: <ul> <li> If the email was delivered (`completed`), a `completed_at` timestamp is included. </li> <li> If the email failed (`failed`), a `not_sent_reason`, `failure_reason`, and `failed_at` timestamp may be included. </li> <li> If the email is still being processed (e.g. `drafted` or `scheduled`), a `retry_after_seconds` value is included to indicate how long to wait before checking again. </li> </ul>需要连接
Use the Check Email Send Status endpoint to check the current delivery status of an email message. This is typically used after calling the <a href="https://docs.apollo.io/reference/send-email-now" target="_blank">Send Email Now endpoint</a>, since emails are sent asynchronously and a successful send response only means the email was queued. <br><br>You must provide the `id` of the email message. The message must belong to your team, otherwise a `404` is returned. <br><br>The response always includes the message `id`, its current `status`, and a human-readable `message`. The remaining fields depend on the status: <ul> <li> If the email was delivered (`completed`), a `completed_at` timestamp is included. </li> <li> If the email failed (`failed`), a `not_sent_reason`, `failure_reason`, and `failed_at` timestamp may be included. </li> <li> If the email is still being processed (e.g. `drafted` or `scheduled`), a `retry_after_seconds` value is included to indicate how long to wait before checking again. </li> </ul>
认证
需要 Connected AccountTags
Complete a TaskAPOLLO_COMPLETE_A_TASKThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Complete a Task endpoint to mark an existing task as `completed`.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to complete.<br><br>If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.<br><br>To skip a task instead of completing it, use the <a href="https://docs.apollo.io/reference/skip-a-task">Skip a Task endpoint</a>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Complete a Task endpoint to mark an existing task as `completed`.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to complete.<br><br>If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.<br><br>To skip a task instead of completing it, use the <a href="https://docs.apollo.io/reference/skip-a-task">Skip a Task endpoint</a>.
认证
需要 Connected AccountTags
Create a ContactAPOLLO_CREATE_A_CONTACTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Create a Contact endpoint to add a new contact to your team's Apollo account.<br><br>By default, Apollo doesn't apply deduplication processes when you create a new contact via API. If your entry has the same name, email address, or other details as an existing contact, Apollo creates a new contact instead of updating the existing contact. To enable deduplication and prevent duplicate contacts, set the <code>run_dedupe</code> parameter to <code>true</code>. <br><br>To update an existing contact, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Create a Contact endpoint to add a new contact to your team's Apollo account.<br><br>By default, Apollo doesn't apply deduplication processes when you create a new contact via API. If your entry has the same name, email address, or other details as an existing contact, Apollo creates a new contact instead of updating the existing contact. To enable deduplication and prevent duplicate contacts, set the <code>run_dedupe</code> parameter to <code>true</code>. <br><br>To update an existing contact, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.
认证
需要 Connected AccountTags
Create a Custom FieldAPOLLO_CREATE_A_CUSTOM_FIELDThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). The Create a Custom Field endpoint lets you add custom fields to your Apollo account, helping your team capture unique details with <a href="https://knowledge.apollo.io/hc/en-us/articles/4412498825869-Create-Custom-Contact-Fields" target="_blank">custom contact</a>, <a href="https://knowledge.apollo.io/hc/en-us/articles/4412498754445-Create-Custom-Account-Fields" target="_blank">custom account</a>, or <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a-Deal" target="_blank">custom deal fields</a>.<br><br>Use these fields to enhance your sequences and deliver more personalized, relevant outreach.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). The Create a Custom Field endpoint lets you add custom fields to your Apollo account, helping your team capture unique details with <a href="https://knowledge.apollo.io/hc/en-us/articles/4412498825869-Create-Custom-Contact-Fields" target="_blank">custom contact</a>, <a href="https://knowledge.apollo.io/hc/en-us/articles/4412498754445-Create-Custom-Account-Fields" target="_blank">custom account</a>, or <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a-Deal" target="_blank">custom deal fields</a>.<br><br>Use these fields to enhance your sequences and deliver more personalized, relevant outreach.
认证
需要 Connected AccountTags
Create a TaskAPOLLO_CREATE_A_TASKThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Create a Task endpoint to create a single task in Apollo for you and your team. Tasks help track the upcoming actions you need to take, such as emailing or calling a contact.<br><br>This endpoint returns the created task object.<br><br>Apollo does not apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo will create a new task instead of updating the existing task.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Create a Task endpoint to create a single task in Apollo for you and your team. Tasks help track the upcoming actions you need to take, such as emailing or calling a contact.<br><br>This endpoint returns the created task object.<br><br>Apollo does not apply deduplication processes when you create a new task via the API. If your entry has the same task owner, contact, and other details as an existing task, Apollo will create a new task instead of updating the existing task.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Create an AccountAPOLLO_CREATE_AN_ACCOUNTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Create an Account endpoint to add a new account to your team's Apollo account.<br><br>Apollo doesn't apply deduplication processes when you create a new account via the API. If your entry has the same name, domain, or other details as an existing account, Apollo creates a new account instead of updating the existing account. To update an existing account, use the <a href="https://docs.apollo.io/reference/update-an-account">Update an Account endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Create an Account endpoint to add a new account to your team's Apollo account.<br><br>Apollo doesn't apply deduplication processes when you create a new account via the API. If your entry has the same name, domain, or other details as an existing account, Apollo creates a new account instead of updating the existing account. To update an existing account, use the <a href="https://docs.apollo.io/reference/update-an-account">Update an Account endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Create an Email DraftAPOLLO_CREATE_AN_EMAIL_DRAFTUse the Create an Email Draft endpoint to create a single, unsent email message (an email draft) for a contact. The draft is created with a `drafted` status — this endpoint does not send the email. <br><br>To send the draft after creating it, call the <a href="https://docs.apollo.io/reference/send-email-now" target="_blank">Send Email Now endpoint</a> with the `id` returned in the response. <br><br>You must provide a `contact_id` so Apollo knows who the email is for. Alternatively, to draft a reply within an existing email thread, provide `in_response_to_emailer_message_id` instead and Apollo will infer the contact and recipients from the parent message. <br><br>The email is drafted from the user that owns the API key. That user must have permission to email the contact (i.e. they own the contact or its account), and the contact must not be blocked by your team's Do Not Contact (DNC) enforcement settings. <br><br>This endpoint returns the created `emailer_message` object. If the draft is linked to an outreach task, a `task` object is also returned.需要连接
Use the Create an Email Draft endpoint to create a single, unsent email message (an email draft) for a contact. The draft is created with a `drafted` status — this endpoint does not send the email. <br><br>To send the draft after creating it, call the <a href="https://docs.apollo.io/reference/send-email-now" target="_blank">Send Email Now endpoint</a> with the `id` returned in the response. <br><br>You must provide a `contact_id` so Apollo knows who the email is for. Alternatively, to draft a reply within an existing email thread, provide `in_response_to_emailer_message_id` instead and Apollo will infer the contact and recipients from the parent message. <br><br>The email is drafted from the user that owns the API key. That user must have permission to email the contact (i.e. they own the contact or its account), and the contact must not be blocked by your team's Do Not Contact (DNC) enforcement settings. <br><br>This endpoint returns the created `emailer_message` object. If the draft is linked to an outreach task, a `task` object is also returned.
认证
需要 Connected AccountTags
Create DealAPOLLO_CREATE_DEALThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the Create Deal endpoint to create new deals for an Apollo account.<br><br>To update existing deals in your Apollo account, use the <a href="https://docs.apollo.io/reference/update-deal">Update Deal endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the Create Deal endpoint to create new deals for an Apollo account.<br><br>To update existing deals in your Apollo account, use the <a href="https://docs.apollo.io/reference/update-deal">Update Deal endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Create a SequenceAPOLLO_CREATE_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Create a Sequence endpoint to create a new sequence in your team's Apollo account, including its steps and email templates.<br><br>To create a sequence with steps, add the `emailer_steps` array to the request body. Each email step (`auto_email`, `manual_email`) can include one or more `emailer_touches` (email variants); adding more than one touch to a step creates an A/B test, which requires a plan with A/B testing access.<br><br>To activate the sequence immediately after creation, set `active` to `true`. Email touches only send if their `status` is `approved`, and a touch can only be approved if its template has a non-empty body.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Create a Sequence endpoint to create a new sequence in your team's Apollo account, including its steps and email templates.<br><br>To create a sequence with steps, add the `emailer_steps` array to the request body. Each email step (`auto_email`, `manual_email`) can include one or more `emailer_touches` (email variants); adding more than one touch to a step creates an A/B test, which requires a plan with A/B testing access.<br><br>To activate the sequence immediately after creation, set `active` to `true`. Email touches only send if their `status` is `approved`, and a touch can only be approved if its template has a non-empty body.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Search for Outreach EmailsAPOLLO_EMAILER_MESSAGES_SEARCHThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Search for Outreach Emails endpoint to find emails that your team has created and sent as part of Apollo sequences.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Search for Outreach Emails endpoint to find emails that your team has created and sent as part of Apollo sequences.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Export ConversationsAPOLLO_EXPORT_CONVERSATIONSThis endpoint consumes Apollo credits when conversations are returned that include AI insights. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Export Conversations endpoint to export conversations within a time range. Exports are processed asynchronously and delivered as a gzipped JSON file. A notification email is sent to the specified team member when the export is ready.<br><br>To get the download URL once the export is ready, refer to <a href="https://docs.apollo.io/docs/get-conversations-export">Get Export</a>.需要连接
This endpoint consumes Apollo credits when conversations are returned that include AI insights. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Export Conversations endpoint to export conversations within a time range. Exports are processed asynchronously and delivered as a gzipped JSON file. A notification email is sent to the specified team member when the export is ready.<br><br>To get the download URL once the export is ready, refer to <a href="https://docs.apollo.io/docs/get-conversations-export">Get Export</a>.
认证
需要 Connected AccountTags
Get a List of All Custom FieldsAPOLLO_GET_A_LIST_OF_ALL_CUSTOM_FIELDSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). This endpoint is deprecated. To achieve the same result, use the <a href="https://docs.apollo.io/reference/get-a-list-of-fields">Fields endpoint</a> (use `source: custom` to get custom fields only).<br><br> Use the Get a List of Custom Fields endpoint to retrieve information about all of the custom fields that have been created in your Apollo account.<br><br>This endpoint doesn't require any parameters. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). This endpoint is deprecated. To achieve the same result, use the <a href="https://docs.apollo.io/reference/get-a-list-of-fields">Fields endpoint</a> (use `source: custom` to get custom fields only).<br><br> Use the Get a List of Custom Fields endpoint to retrieve information about all of the custom fields that have been created in your Apollo account.<br><br>This endpoint doesn't require any parameters. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get a List of All ListsAPOLLO_GET_A_LIST_OF_ALL_LISTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get a List of All Lists endpoint to retrieve information about every list that has been created in your Apollo account. This endpoint can be used to check the available lists before you use the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a>. <br><br>This endpoint doesn't require any parameters.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get a List of All Lists endpoint to retrieve information about every list that has been created in your Apollo account. This endpoint can be used to check the available lists before you use the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a>. <br><br>This endpoint doesn't require any parameters.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get a List of Email AccountsAPOLLO_GET_A_LIST_OF_EMAIL_ACCOUNTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). You can <a href="https://knowledge.apollo.io/hc/en-us/articles/4409127806093-Link-Your-Mailbox-to-Apollo" target="_blank">link mailboxes to Apollo</a>, and use them for prospect outreach.<br><br>Use the Get a List of Email Accounts endpoint to retrieve information about the linked email inboxes that your teammates use in your Apollo account.<br><br>In particular, this endpoint returns IDs for each of your team's linked email accounts, which can be used with the <a href="https://docs.apollo.io/reference/add-contacts-to-sequence">Add Contacts to a Sequence endpoint</a>.<br><br>This endpoint doesn't require any parameters.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). You can <a href="https://knowledge.apollo.io/hc/en-us/articles/4409127806093-Link-Your-Mailbox-to-Apollo" target="_blank">link mailboxes to Apollo</a>, and use them for prospect outreach.<br><br>Use the Get a List of Email Accounts endpoint to retrieve information about the linked email inboxes that your teammates use in your Apollo account.<br><br>In particular, this endpoint returns IDs for each of your team's linked email accounts, which can be used with the <a href="https://docs.apollo.io/reference/add-contacts-to-sequence">Add Contacts to a Sequence endpoint</a>.<br><br>This endpoint doesn't require any parameters.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get a List of FieldsAPOLLO_GET_A_LIST_OF_FIELDSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get a List of Fields endpoint to retrieve information about all of the fields that exist in your Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get a List of Fields endpoint to retrieve information about all of the fields that exist in your Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get a List of NotesAPOLLO_GET_A_LIST_OF_NOTESThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28746467476365-Notes-Overview" target="_blank">Notes</a> on Apollo let you keep track of info directly on prospect profiles.<br><br>The Get a List of Notes endpoint retrieves notes associated with a specific contact, account, opportunity, calendar event, or conversation in your Apollo account. You must provide at least one relation parameter (<code>account_id</code>, <code>contact_id</code>, <code>contact_ids</code>, <code>opportunity_id</code>, <code>calendar_event_id</code>, <code>conversation_id</code>, or <code>conversation_ids</code>). Use this endpoint to fetch notes with sorting and pagination support.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28746467476365-Notes-Overview" target="_blank">Notes</a> on Apollo let you keep track of info directly on prospect profiles.<br><br>The Get a List of Notes endpoint retrieves notes associated with a specific contact, account, opportunity, calendar event, or conversation in your Apollo account. You must provide at least one relation parameter (<code>account_id</code>, <code>contact_id</code>, <code>contact_ids</code>, <code>opportunity_id</code>, <code>calendar_event_id</code>, <code>conversation_id</code>, or <code>conversation_ids</code>). Use this endpoint to fetch notes with sorting and pagination support.
认证
需要 Connected AccountTags
Get a List of UsersAPOLLO_GET_A_LIST_OF_USERSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.<br><br>These IDs can be used for several other endpoints, including the <a href="https://docs.apollo.io/reference/create-deal">Create a Deal</a>, <a href="https://docs.apollo.io/reference/create-an-account">Create an Account</a>, and <a href="https://docs.apollo.io/reference/create-task">Create a Task</a> endpoints.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master API key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get a List of Users endpoint to retrieve the IDs for all of the users in your Apollo account.<br><br>These IDs can be used for several other endpoints, including the <a href="https://docs.apollo.io/reference/create-deal">Create a Deal</a>, <a href="https://docs.apollo.io/reference/create-an-account">Create an Account</a>, and <a href="https://docs.apollo.io/reference/create-task">Create a Task</a> endpoints.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master API key.
认证
需要 Connected AccountTags
Get a TaskAPOLLO_GET_A_TASKThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Get a Task endpoint to retrieve the full details for a single task that belongs to your team's Apollo account.<br><br>The response includes the task's associated <a href="https://docs.apollo.io/reference/view-an-account">account</a> and <a href="https://docs.apollo.io/reference/view-a-contact">contact</a> when the task has one attached. Depending on the task type, the response can also include other fields, such as `phone_call` for call tasks, `emailer_message` for email tasks, or a LinkedIn message template for LinkedIn-step tasks.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to view.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Get a Task endpoint to retrieve the full details for a single task that belongs to your team's Apollo account.<br><br>The response includes the task's associated <a href="https://docs.apollo.io/reference/view-an-account">account</a> and <a href="https://docs.apollo.io/reference/view-a-contact">contact</a> when the task has one attached. Depending on the task type, the response can also include other fields, such as `phone_call` for call tasks, `emailer_message` for email tasks, or a LinkedIn message template for LinkedIn-step tasks.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to view.
认证
需要 Connected AccountTags
View an AccountAPOLLO_GET_ACCOUNTS_IDThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the View an Account endpoint to retrieve details for an existing account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create API keys</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the View an Account endpoint to retrieve details for an existing account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create API keys</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get Conversations ExportAPOLLO_GET_CONVERSATIONS_EXPORTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Get Conversations Export endpoint to retrieve a download URL for your exported conversations.<br><br>This endpoint is used as a follow-up to the <a href="https://docs.apollo.io/docs/export-conversations">Export Conversations</a> endpoint.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Get Conversations Export endpoint to retrieve a download URL for your exported conversations.<br><br>This endpoint is used as a follow-up to the <a href="https://docs.apollo.io/docs/export-conversations">Export Conversations</a> endpoint.
认证
需要 Connected AccountTags
Get Conversations InfoAPOLLO_GET_CONVERSATIONS_INFOThis endpoint consumes Apollo credits per record when conversations with AI insights are returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Get Conversation Info endpoint to retrieve the full details of a single conversation by its ID.<br><br>To get a conversation's ID, refer to <a href="https://docs.apollo.io/docs/search-conversations">Search Conversations</a>.需要连接
This endpoint consumes Apollo credits per record when conversations with AI insights are returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Get Conversation Info endpoint to retrieve the full details of a single conversation by its ID.<br><br>To get a conversation's ID, refer to <a href="https://docs.apollo.io/docs/search-conversations">Search Conversations</a>.
认证
需要 Connected AccountTags
Get Current User ProfileAPOLLO_GET_CURRENT_USER_PROFILEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get Current User Profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.<br><br>By default, the endpoint returns the user's identity fields. Set the `include_credit_usage` query parameter to `true` to also return the user's and team's credit usage and remaining credit balances.<br><br>If you call this endpoint without valid access credentials, you receive a `401` response.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Manage-and-Deactivate-Users" target="_blank">Users</a> are the people who use your Apollo workspace.<br><br>Use the Get Current User Profile endpoint to retrieve the authenticated profile of the person who owns the API key being used.<br><br>By default, the endpoint returns the user's identity fields. Set the `include_credit_usage` query parameter to `true` to also return the user's and team's credit usage and remaining credit balances.<br><br>If you call this endpoint without valid access credentials, you receive a `401` response.
认证
需要 Connected AccountTags
Check Email StatsAPOLLO_GET_EMAILSTATSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Check Email Stats endpoint to review the complete details for an email sent as part of an Apollo sequence. This includes the contents of the emails, stats related to the email such as opens and clicks, and details about the contact that received the email.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Check Email Stats endpoint to review the complete details for an email sent as part of an Apollo sequence. This includes the contents of the emails, stats related to the email such as opens and clicks, and details about the contact that received the email.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get Complete Organization InfoAPOLLO_GET_ORGANIZATIONS_IDThis endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Get Complete Organization Info endpoint to retrieve complete details about an organization in Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Get Complete Organization Info endpoint to retrieve complete details about an organization in Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Get Complete Person InfoAPOLLO_GET_PEOPLE_IDThis endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get Complete Person Info endpoint to retrieve complete details about a person in the Apollo database, including employment history, location, and the full details of the person's current organization.<br><br>This endpoint requires a master API key. If you call this endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint consumes Apollo credits per record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Get Complete Person Info endpoint to retrieve complete details about a person in the Apollo database, including employment history, location, and the full details of the person's current organization.<br><br>This endpoint requires a master API key. If you call this endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Search for CallsAPOLLO_GET_PHONE_CALLSSEARCHThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Search for Calls endpoint to find calls that your team has made or received using <a href="https://knowledge.apollo.io/hc/en-us/articles/4409140527757-Dialer-Overview" target="_blank">the dialer</a> on Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master API key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Search for Calls endpoint to find calls that your team has made or received using <a href="https://knowledge.apollo.io/hc/en-us/articles/4409140527757-Dialer-Overview" target="_blank">the dialer</a> on Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master API key.
认证
需要 Connected AccountTags
List Account StagesAPOLLO_LIST_ACCOUNT_STAGESThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Account stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the List Accounts Stages endpoint to retrieve the IDs for the available account stages in your team's Apollo account. This endpoint doesn't require parameters. <br><br>Account stage IDs can be used to <a href="https://docs.apollo.io/reference/update-an-account">update individual accounts</a> and <a href="https://docs.apollo.io/reference/bulk-update-accounts">update the account stages for multiple accounts</a> via Apollo API. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Account stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the List Accounts Stages endpoint to retrieve the IDs for the available account stages in your team's Apollo account. This endpoint doesn't require parameters. <br><br>Account stage IDs can be used to <a href="https://docs.apollo.io/reference/update-an-account">update individual accounts</a> and <a href="https://docs.apollo.io/reference/bulk-update-accounts">update the account stages for multiple accounts</a> via Apollo API. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
List All DealsAPOLLO_LIST_ALL_DEALSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the List All Deals endpoint to retrieve every deal that has been created for your team's Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the List All Deals endpoint to retrieve every deal that has been created for your team's Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
List Contact StagesAPOLLO_LIST_CONTACT_STAGESThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Contact stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the List Contact Stages endpoint to retrieve the IDs for the available contact stages in your team's Apollo account. <br><br>Contact stage IDs can be used to <a href="https://docs.apollo.io/reference/update-a-contact">update individual contacts</a> and <a href="https://docs.apollo.io/reference/update-contact-stage">update the contact stages for multiple contacts</a> via Apollo API.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Contact stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the List Contact Stages endpoint to retrieve the IDs for the available contact stages in your team's Apollo account. <br><br>Contact stage IDs can be used to <a href="https://docs.apollo.io/reference/update-a-contact">update individual contacts</a> and <a href="https://docs.apollo.io/reference/update-contact-stage">update the contact stages for multiple contacts</a> via Apollo API.
认证
需要 Connected AccountTags
List Deal StagesAPOLLO_LIST_DEAL_STAGESThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the List Deal Stages endpoint to retrieve information about every deal stage that's available in your team's Apollo account.<br><br>The `id` value for each deal stage can be used to set the stage when <a href="https://docs.apollo.io/reference/create-deal">creating a deal</a> or <a href="https://docs.apollo.io/reference/update-deal">updating a deal</a> via the Apollo API.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the List Deal Stages endpoint to retrieve information about every deal stage that's available in your team's Apollo account.<br><br>The `id` value for each deal stage can be used to set the stage when <a href="https://docs.apollo.io/reference/create-deal">creating a deal</a> or <a href="https://docs.apollo.io/reference/update-deal">updating a deal</a> via the Apollo API.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
News Articles SearchAPOLLO_NEWS_ARTICLES_SEARCHThis endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412665755661-Search-Filters-Overview#news" target="_blank">News</a> includes articles related to companies in Apollo.<br><br>Use the News Articles Search endpoint to find news articles related to specific companies. Several filters are available to help narrow your search.需要连接
This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412665755661-Search-Filters-Overview#news" target="_blank">News</a> includes articles related to companies in Apollo.<br><br>Use the News Articles Search endpoint to find news articles related to specific companies. Several filters are available to help narrow your search.
认证
需要 Connected AccountTags
Organization EnrichmentAPOLLO_ORGANIZATION_ENRICHMENTThis endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Organization Enrichment endpoint to enrich data for one company. To enrich data for up to ten companies with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-organization-enrichment">Bulk Organization Enrichment endpoint</a> instead.<br><br>You can match the company to enrich by domain, LinkedIn URL, name, and/or website. At least one of these is required, and providing more than one improves match accuracy.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, corporate phone numbers, and locations.需要连接
This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the Organization Enrichment endpoint to enrich data for one company. To enrich data for up to ten companies with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-organization-enrichment">Bulk Organization Enrichment endpoint</a> instead.<br><br>You can match the company to enrich by domain, LinkedIn URL, name, and/or website. At least one of these is required, and providing more than one improves match accuracy.<br><br>Enriched data potentially includes industry information, revenue, employee counts, funding round details, corporate phone numbers, and locations.
认证
需要 Connected AccountTags
Organization Job PostingsAPOLLO_ORGANIZATION_JOBS_POSTINGSThis endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Organization Job Postings endpoint to retrieve the current job postings for companies. This can help you identify companies that are growing headcount in areas that are strategically important for you.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 10,000 records.需要连接
This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Organization Job Postings endpoint to retrieve the current job postings for companies. This can help you identify companies that are growing headcount in areas that are strategically important for you.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 10,000 records.
认证
需要 Connected AccountTags
Organization SearchAPOLLO_ORGANIZATION_SEARCHThis endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Organization Search endpoint to find companies in the Apollo database. Several filters are available to help narrow your search.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.需要连接
This endpoint consumes Apollo credits per page when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658766477-Search-for-Companies" target="_blank">Organizations</a> are companies you haven't yet saved as accounts on Apollo.<br><br>Use the Organization Search endpoint to find companies in the Apollo database. Several filters are available to help narrow your search.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
认证
需要 Connected AccountTags
People API SearchAPOLLO_PEOPLE_API_SEARCHThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658716941-Search-for-People" target="_blank">People</a> are net-new prospects you haven't yet saved as contacts on Apollo.<br><br>Use the People API Search endpoint to find new prospects. Several filters are available to help narrow your search. This endpoint doesn't return email addresses or phone numbers. Use the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment</a> or <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment</a> endpoints to enrich data.<br><br>This endpoint requires a master API key. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4412658716941-Search-for-People" target="_blank">People</a> are net-new prospects you haven't yet saved as contacts on Apollo.<br><br>Use the People API Search endpoint to find new prospects. Several filters are available to help narrow your search. This endpoint doesn't return email addresses or phone numbers. Use the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment</a> or <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment</a> endpoints to enrich data.<br><br>This endpoint requires a master API key. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
认证
需要 Connected AccountTags
People EnrichmentAPOLLO_PEOPLE_ENRICHMENTThis endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the People Enrichment endpoint to enrich data for one person. To enrich data for up to ten people with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a `200` response, but the response indicates that no records have been enriched.<br><br>By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers.<br><br>You can also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.<br><br> **Webhook Response Details:** - When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details) - When passing Waterfall flags, the webhook response follows: [Waterfall webhook response Details](doc:enrich-phone-and-email-using-data-waterfall#response-details) - You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing <code>request_id</code>. **Webhook Requirements:** - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS. - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo. - **Idempotency:** Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.需要连接
This endpoint consumes Apollo credits per enriched record when data is returned. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichment-Overview" target="_blank">Enrichment</a> is when you refresh existing records so your prospecting data is up-to-date.<br><br>Use the People Enrichment endpoint to enrich data for one person. To enrich data for up to ten people with a single API call, use the <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment endpoint</a> instead.<br><br>Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a `200` response, but the response indicates that no records have been enriched.<br><br>By default, this endpoint doesn't return personal emails or phone numbers. Use the `reveal_personal_emails` and `reveal_phone_number` parameters to retrieve emails and phone numbers.<br><br>You can also use the `run_waterfall_email` and `run_waterfall_phone` parameters to run waterfall enrichment via this endpoint. [Waterfall enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-Waterfall-Enrichment-Overview) gives you broader data coverage by checking connected third-party data sources for contact emails and phone numbers. When you call this endpoint and include at least one waterfall parameter, Apollo returns an immediate synchronous response with demographic and firmographic data, along with a waterfall enrichment request status. Apollo delivers enriched emails and/or phone numbers asynchronously to a configured webhook.<br><br> **Webhook Response Details:** - When using native enrichment for phone number enrichment, the webhook response follows: [Native webhook response details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-details) - When passing Waterfall flags, the webhook response follows: [Waterfall webhook response Details](doc:enrich-phone-and-email-using-data-waterfall#response-details) - You can poll webhook results with the [Poll Webhook Result endpoint](doc:poll-webhook-result) by passing <code>request_id</code>. **Webhook Requirements:** - **HTTPS Required:** Your endpoint must be publicly accessible over HTTPS. - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of webhook traffic sent by Apollo. - **Idempotency:** Apollo may retry webhook calls; your endpoint should be idempotent to handle duplicate payloads safely.
认证
需要 Connected AccountTags
Create Call RecordsAPOLLO_PHONECALLS_CREATEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Create Call Records endpoint to log calls in Apollo that were made using outside systems such as Orum or Nooks. This endpoint can only be used create call records, not to dial prospects.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Create Call Records endpoint to log calls in Apollo that were made using outside systems such as Orum or Nooks. This endpoint can only be used create call records, not to dial prospects.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Poll Webhook ResultAPOLLO_POLL_WEBHOOK_RESULTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Poll Webhook Result endpoint to retrieve webhook results from Apollo. This endpoint enables you to poll for the webhook payload if you didn't receive the original webhook callback. <br><br>To use this endpoint, you need the <code>request_id</code> from the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment</a> or <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment</a> endpoint. Pass this value as <code>request_id</code> in this endpoint.<br><br>This endpoint returns webhook results for your team from up to thirty days after the webhook was triggered.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Poll Webhook Result endpoint to retrieve webhook results from Apollo. This endpoint enables you to poll for the webhook payload if you didn't receive the original webhook callback. <br><br>To use this endpoint, you need the <code>request_id</code> from the <a href="https://docs.apollo.io/reference/people-enrichment">People Enrichment</a> or <a href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People Enrichment</a> endpoint. Pass this value as <code>request_id</code> in this endpoint.<br><br>This endpoint returns webhook results for your team from up to thirty days after the webhook was triggered.
认证
需要 Connected AccountTags
View API Usage Stats and Rate LimitsAPOLLO_POST_APIUSAGEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the View API Usage Stats endpoint to view your team's usage of Apollo API and your rate limit for API endpoints.<br><br>Each endpoint has a rate limit per minute, hour, and day. Your <a href="https://docs.apollo.io/docs/api-pricing">Apollo plan</a> does impact the rate limits for API endpoints.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the View API Usage Stats endpoint to view your team's usage of Apollo API and your rate limit for API endpoints.<br><br>Each endpoint has a rate limit per minute, hour, and day. Your <a href="https://docs.apollo.io/docs/api-pricing">Apollo plan</a> does impact the rate limits for API endpoints.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Update Call RecordsAPOLLO_PUT_PHONE_CALLSUPDATEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Update Call Records endpoint to update your team's call records in Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Update Call Records endpoint to update your team's call records in Apollo.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Search ConversationsAPOLLO_SEARCH_CONVERSATIONSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Search Conversations endpoint to find a list of conversations. Several filters are available to help narrow your search, including by type, account, contact, date range, and more. Each result includes a summary of the conversation.<br><br>This endpoint doesn't include transcripts or recording URLs. Use the conversation ID retrieved from your search to request full details using <a href="https://docs.apollo.io/docs/get-conversations-info">Get Conversations Info</a>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/45998035787533-Use-Conversations">Conversations</a> are prospect video meetings stored in Apollo.<br><br>Use the Search Conversations endpoint to find a list of conversations. Several filters are available to help narrow your search, including by type, account, contact, date range, and more. Each result includes a summary of the conversation.<br><br>This endpoint doesn't include transcripts or recording URLs. Use the conversation ID retrieved from your search to request full details using <a href="https://docs.apollo.io/docs/get-conversations-info">Get Conversations Info</a>.
认证
需要 Connected AccountTags
Search for AccountsAPOLLO_SEARCH_FOR_ACCOUNTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Search for Accounts endpoint to search for an account that has been saved to Apollo.<br><br>This endpoint only returns accounts in the search results. To search for companies in Apollo, call the <a href="https://docs.apollo.io/reference/organization-search">Organization Search endpoint</a>.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Search for Accounts endpoint to search for an account that has been saved to Apollo.<br><br>This endpoint only returns accounts in the search results. To search for companies in Apollo, call the <a href="https://docs.apollo.io/reference/organization-search">Organization Search endpoint</a>.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
认证
需要 Connected AccountTags
Search for ContactsAPOLLO_SEARCH_FOR_CONTACTSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Search for Contacts endpoint to search for the contacts that have been added to your team's Apollo account.<br><br>This endpoint only returns contacts in the search results. To search for people in the Apollo database, call the <a href="https://docs.apollo.io/reference/people-api-search">People API Search endpoint</a>.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Search for Contacts endpoint to search for the contacts that have been added to your team's Apollo account.<br><br>This endpoint only returns contacts in the search results. To search for people in the Apollo database, call the <a href="https://docs.apollo.io/reference/people-api-search">People API Search endpoint</a>.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.
认证
需要 Connected AccountTags
Search for SequencesAPOLLO_SEARCH_FOR_SEQUENCESThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Search for Sequences endpoint to search for the sequences that have been created for your team's Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Search for Sequences endpoint to search for the sequences that have been created for your team's Apollo account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Search for TasksAPOLLO_SEARCH_TASKSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Search for Tasks endpoint to find tasks that your team has created in Apollo.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Search for Tasks endpoint to find tasks that your team has created in Apollo.<br><br>To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Send Email NowAPOLLO_SEND_EMAIL_NOWUse the Send Email Now endpoint to immediately send an existing email message. This works for emails that are currently in a `drafted`, `scheduled`, or `failed` state — Apollo schedules the email to be sent right away and processes it asynchronously. <br><br>To first create an email draft, use the <a href="https://docs.apollo.io/reference/create-an-email-draft" target="_blank">Create an Email Draft endpoint</a> and then pass the returned `id` to this endpoint. <br><br>The email is sent from the user that owns the API key. That user must have a linked email account on the message, must have permission to send from that email account, and must have permission to email the contact. The contact must also not be blocked by your team's Do Not Contact (DNC) enforcement settings, and the user must not have exceeded their daily sending limit. <br><br>Because sending is processed asynchronously, a successful `200` response means the email has been queued for sending — not that it has been delivered. To check whether the email was delivered, poll the <a href="https://docs.apollo.io/reference/check-email-send-status" target="_blank">Check Email Send Status endpoint</a> using the message `id`. <br><br>This endpoint returns the `emailer_message` object. If the message is linked to an outreach task, a `task` object is also returned.需要连接
Use the Send Email Now endpoint to immediately send an existing email message. This works for emails that are currently in a `drafted`, `scheduled`, or `failed` state — Apollo schedules the email to be sent right away and processes it asynchronously. <br><br>To first create an email draft, use the <a href="https://docs.apollo.io/reference/create-an-email-draft" target="_blank">Create an Email Draft endpoint</a> and then pass the returned `id` to this endpoint. <br><br>The email is sent from the user that owns the API key. That user must have a linked email account on the message, must have permission to send from that email account, and must have permission to email the contact. The contact must also not be blocked by your team's Do Not Contact (DNC) enforcement settings, and the user must not have exceeded their daily sending limit. <br><br>Because sending is processed asynchronously, a successful `200` response means the email has been queued for sending — not that it has been delivered. To check whether the email was delivered, poll the <a href="https://docs.apollo.io/reference/check-email-send-status" target="_blank">Check Email Send Status endpoint</a> using the message `id`. <br><br>This endpoint returns the `emailer_message` object. If the message is linked to an outreach task, a `task` object is also returned.
认证
需要 Connected AccountTags
Skip a TaskAPOLLO_SKIP_A_TASKThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Skip a Task endpoint to mark an existing task as `skipped` without completing it.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to skip.<br><br>If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.<br><br>To mark a task as done instead of skipping it, use the <a href="https://docs.apollo.io/reference/complete-a-task">Complete a Task endpoint</a>.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Skip a Task endpoint to mark an existing task as `skipped` without completing it.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to skip.<br><br>If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a `200` response with `deleted: true` on the task instead of an error.<br><br>To mark a task as done instead of skipping it, use the <a href="https://docs.apollo.io/reference/complete-a-task">Complete a Task endpoint</a>.
认证
需要 Connected AccountTags
Query Analytics ReportAPOLLO_SYNC_REPORTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Query Analytics Report endpoint to programmatically query <a href="https://knowledge.apollo.io/hc/en-us/articles/33574373762317-Analytics-Overview" target="_blank">Apollo analytics</a> and retrieve aggregated sales activity data for your team.<br><br>This endpoint accepts a flexible payload specifying which metrics to measure, how to group and filter results, and which date range to apply — returning the same data that powers Apollo's built-in Analytics dashboards. <br><br>Three query modes are supported: flat totals (no <code>group_by</code>), grouped by one dimension such as user or sequence, and pivot cross-tab (one <code>group_by</code> dimension as rows + one <code>pivot_group_by</code> dimension as columns). Each array supports a maximum of one entry.<br><br> <strong>Authentication:</strong> Requires an Apollo API key with access to the <code>api/v1/reports/sync_report</code> API. When creating or editing an API key in Apollo Settings, open the <strong>APIs</strong> tab and select <code>api/v1/reports/sync_report</code> from the list. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> for detailed instructions.<br><br><strong>Tip:</strong> The easiest way to discover valid metric and group_by combinations is to build a report interactively at <a href="https://app.apollo.io/#/analytics/reports/new" target="_blank">Apollo Analytics → Start from scratch</a>, then replicate that configuration in your API request.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). Use the Query Analytics Report endpoint to programmatically query <a href="https://knowledge.apollo.io/hc/en-us/articles/33574373762317-Analytics-Overview" target="_blank">Apollo analytics</a> and retrieve aggregated sales activity data for your team.<br><br>This endpoint accepts a flexible payload specifying which metrics to measure, how to group and filter results, and which date range to apply — returning the same data that powers Apollo's built-in Analytics dashboards. <br><br>Three query modes are supported: flat totals (no <code>group_by</code>), grouped by one dimension such as user or sequence, and pivot cross-tab (one <code>group_by</code> dimension as rows + one <code>pivot_group_by</code> dimension as columns). Each array supports a maximum of one entry.<br><br> <strong>Authentication:</strong> Requires an Apollo API key with access to the <code>api/v1/reports/sync_report</code> API. When creating or editing an API key in Apollo Settings, open the <strong>APIs</strong> tab and select <code>api/v1/reports/sync_report</code> from the list. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> for detailed instructions.<br><br><strong>Tip:</strong> The easiest way to discover valid metric and group_by combinations is to build a report interactively at <a href="https://app.apollo.io/#/analytics/reports/new" target="_blank">Apollo Analytics → Start from scratch</a>, then replicate that configuration in your API request.
认证
需要 Connected AccountTags
Update a ContactAPOLLO_UPDATE_A_CONTACTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Update a Contact endpoint to update existing contacts in your team's Apollo account.<br><br>To create a new contact, use the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a> instead. To update the contact stage for multiple contacts, use the <a href="https://docs.apollo.io/reference/update-contact-stage">Update Contact Stage for Multiple Contacts</a> endpoint.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the Update a Contact endpoint to update existing contacts in your team's Apollo account.<br><br>To create a new contact, use the <a href="https://docs.apollo.io/reference/create-a-contact">Create a Contact endpoint</a> instead. To update the contact stage for multiple contacts, use the <a href="https://docs.apollo.io/reference/update-contact-stage">Update Contact Stage for Multiple Contacts</a> endpoint.
认证
需要 Connected AccountTags
Update a TaskAPOLLO_UPDATE_A_TASKThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Update a Task endpoint to change the details of an existing task that belongs to your team's Apollo account.<br><br>The fields you can update depend on the task's current `status`. For a task with a `scheduled` status, you can update any of the parameters listed below. For a task that's already `completed` or `skipped`, you can only update `note`, `priority`, `priority_cd`, and `contact_id`.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to update.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Update a Task endpoint to change the details of an existing task that belongs to your team's Apollo account.<br><br>The fields you can update depend on the task's current `status`. For a task with a `scheduled` status, you can update any of the parameters listed below. For a task that's already `completed` or `skipped`, you can only update `note`, `priority`, `priority_cd`, and `contact_id`.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the `id` value for the task you want to update.
认证
需要 Connected AccountTags
Update Account Owner for Multiple AccountsAPOLLO_UPDATE_ACCOUNT_OWNERSHIPThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5631686093069-Edit-a-Contact-or-Account-Owner" target="_blank">Account owners</a> manage saved accounts in Apollo.<br><br>Use the Update Account Owner for Multiple Accounts endpoint to assign multiple accounts to a different user in your team's Apollo account.<br><br>To update more than the account owner, such as domains or phone numbers, use the <a href="https://docs.apollo.io/reference/update-an-account">Update an Account endpoint</a> instead. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5631686093069-Edit-a-Contact-or-Account-Owner" target="_blank">Account owners</a> manage saved accounts in Apollo.<br><br>Use the Update Account Owner for Multiple Accounts endpoint to assign multiple accounts to a different user in your team's Apollo account.<br><br>To update more than the account owner, such as domains or phone numbers, use the <a href="https://docs.apollo.io/reference/update-an-account">Update an Account endpoint</a> instead. <br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Update an AccountAPOLLO_UPDATE_AN_ACCOUNTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Update an Account endpoint to update existing accounts in your team's Apollo account.<br><br>To create a new account, use the <a href="https://docs.apollo.io/reference/create-an-account">Create an Account endpoint</a> instead. To update the account stage for multiple accounts, use the <a href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update Accounts endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). An <a href="https://knowledge.apollo.io/hc/en-us/articles/5995865049229-View-and-Edit-Accounts" target="_blank">account</a> is a company saved in Apollo.<br><br>Use the Update an Account endpoint to update existing accounts in your team's Apollo account.<br><br>To create a new account, use the <a href="https://docs.apollo.io/reference/create-an-account">Create an Account endpoint</a> instead. To update the account stage for multiple accounts, use the <a href="https://docs.apollo.io/reference/bulk-update-accounts">Bulk Update Accounts endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Update Contact Owner for Multiple ContactsAPOLLO_UPDATE_CONTACT_OWNERSHIPThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5631686093069-Edit-a-Contact-or-Account-Owner" target="_blank">Contact owners</a> manage specific contacts in Apollo.<br><br>Use the Update Contact Owner for Multiple Contacts endpoint to assign multiple contacts to a different user in your team's Apollo account. <br><br>To update more than the contact's owner, such as job titles or contact details, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5631686093069-Edit-a-Contact-or-Account-Owner" target="_blank">Contact owners</a> manage specific contacts in Apollo.<br><br>Use the Update Contact Owner for Multiple Contacts endpoint to assign multiple contacts to a different user in your team's Apollo account. <br><br>To update more than the contact's owner, such as job titles or contact details, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.
认证
需要 Connected AccountTags
Update Contact Stage for Multiple ContactsAPOLLO_UPDATE_CONTACT_STAGEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Contact stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the Update Contact Stage for Multiple Contacts endpoint to update the contact stage for several contacts in your team's Apollo account.<br><br>To update more than the contact stage, such as job titles or contact details, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4410623601165-Contact-and-Account-Stages-Overview" target="_blank">Contact stages</a> help you track progress on sales and marketing pipelines.<br><br>Use the Update Contact Stage for Multiple Contacts endpoint to update the contact stage for several contacts in your team's Apollo account.<br><br>To update more than the contact stage, such as job titles or contact details, use the <a href="https://docs.apollo.io/reference/update-a-contact">Update a Contact endpoint</a> instead.
认证
需要 Connected AccountTags
Update Contact Status in a SequenceAPOLLO_UPDATE_CONTACT_STATUS_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Update Contact Status in a Sequence endpoint to either mark contacts as having `finished` a sequence, or to remove them from a sequence entirely.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Update Contact Status in a Sequence endpoint to either mark contacts as having `finished` a sequence, or to remove them from a sequence entirely.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Update DealAPOLLO_UPDATE_DEALThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the Update Deal endpoint to update the details of existing deals within your team's Apollo account.<br><br>To create new deals in your Apollo account, use the <a href="https://docs.apollo.io/reference/create-deal">Create Deal endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the Update Deal endpoint to update the details of existing deals within your team's Apollo account.<br><br>To create new deals in your Apollo account, use the <a href="https://docs.apollo.io/reference/create-deal">Create Deal endpoint</a> instead.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
Update a SequenceAPOLLO_UPDATE_SEQUENCEThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Update a Sequence endpoint to update an existing sequence (emailer campaign) in your team's Apollo account.<br><br>You can update sequence-level settings, such as the name, active state, schedule, and sending limits, as well as the sequence's steps and the email touches within each step. <br><br>To turn a sequence on or off, set the `active` field. Passing `emailer_steps` will create, update, reorder, or remove steps and their touches based on the IDs you provide.<br><br>To create a new sequence instead, use the <a href="https://docs.apollo.io/reference/create-a-sequence">Create a Sequence endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Update a Sequence endpoint to update an existing sequence (emailer campaign) in your team's Apollo account.<br><br>You can update sequence-level settings, such as the name, active state, schedule, and sending limits, as well as the sequence's steps and the email touches within each step. <br><br>To turn a sequence on or off, set the `active` field. Passing `emailer_steps` will create, update, reorder, or remove steps and their touches based on the IDs you provide.<br><br>To create a new sequence instead, use the <a href="https://docs.apollo.io/reference/create-a-sequence">Create a Sequence endpoint</a>.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
View a ContactAPOLLO_VIEW_A_CONTACTThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the View a Contact endpoint to retrieve details for an existing contact in your team's Apollo database.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/5995459280525-View-and-Edit-Contacts" target="_blank">Contacts</a> are people saved in Apollo.<br><br>Use the View a Contact endpoint to retrieve details for an existing contact in your team's Apollo database.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags
View Associated DealsAPOLLO_VIEW_ASSOCIATED_DEALSThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the View Associated Deals endpoint to retrieve the deals associated with a contact.<br><br>This endpoint doesn't require a request body. If you include one, Apollo doesn't read its fields. An empty JSON <code>{}</code> is sufficient.<br><br>Each result returns the same deal details as <a href="https://docs.apollo.io/reference/view-deal">View Deal</a> endpoint. If the contact has no associated deals or the contact ID isn't recognized, Apollo returns a <code>200</code> response with an empty array rather than a <code>404</code> error.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the View Associated Deals endpoint to retrieve the deals associated with a contact.<br><br>This endpoint doesn't require a request body. If you include one, Apollo doesn't read its fields. An empty JSON <code>{}</code> is sufficient.<br><br>Each result returns the same deal details as <a href="https://docs.apollo.io/reference/view-deal">View Deal</a> endpoint. If the contact has no associated deals or the contact ID isn't recognized, Apollo returns a <code>200</code> response with an empty array rather than a <code>404</code> error.
认证
需要 Connected AccountTags
View DealAPOLLO_VIEW_DEALThis endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the View Deal endpoint to retrieve complete details about a deal within your team's Apollo account.<br><br>Deal information can include the ID of the deal owner, the monetary value of the deal, the deal stage, and general details about the account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.需要连接
This endpoint doesn't consume Apollo credits. Learn more about [API pricing and credits](https://docs.apollo.io/docs/api-pricing). <a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities.<br><br>Use the View Deal endpoint to retrieve complete details about a deal within your team's Apollo account.<br><br>Deal information can include the ID of the deal owner, the monetary value of the deal, the deal stage, and general details about the account.<br><br>This endpoint requires a master API key. If you call the endpoint without a master key, you receive a `403` response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.
认证
需要 Connected AccountTags