{ "opencollection": "1.0.0", "info": { "name": "Apollo.io Calls API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Calls", "type": "folder" }, "items": [ { "info": { "name": "Search for Calls", "type": "http" }, "http": { "method": "GET", "url": "https://api.apollo.io/api/v1/phone_calls/search", "params": [ { "name": "date_range[max]", "value": "", "type": "query", "description": "Set the upper bound of the date range you want to search.

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

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

Example: `2025-06-12`" }, { "name": "date_range[min]", "value": "", "type": "query", "description": "Set the lower bound of the date range you want to search.

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

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

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

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

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

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

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

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

Example: `67e33d527de088000daa60c4`" }, { "name": "contact_label_ids[]", "value": "", "type": "query", "description": "Find calls that included specific contacts. You can add multiple contacts.

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

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

Example: `67e33d527de088000daa60c4` 6708415f59d9c70001b2f852" }, { "name": "phone_call_purpose_ids[]", "value": "", "type": "query", "description": "Filter calls based on their purpose.

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

Example: `6095a710bd01d100a506d4cf`" }, { "name": "phone_call_outcome_ids[]", "value": "", "type": "query", "description": "Filter calls based on their outcome.

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

Example: `6095a710bd01d100a506d4c5`" }, { "name": "q_keywords", "value": "", "type": "query", "description": "Add keywords to narrow the search of the calls in your team's Apollo account.

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

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

Example: `4`" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance.

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

Example: `10`" } ] }, "docs": "## Endpoint essentials\n\n**API key access:** `Master API key`\n\n**OAuth scopes:** `phone_call_search`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Search for Calls endpoint to find calls that your team has made or received using the dialer on Apollo." }, { "info": { "name": "Create Call Records", "type": "http" }, "http": { "method": "POST", "url": "https://api.apollo.io/api/v1/phone_calls", "params": [ { "name": "logged", "value": "", "type": "query", "description": "Set to `true` if you want to create an individual record for the phone call in Apollo." }, { "name": "user_id[]", "value": "", "type": "query", "description": "Designate the caller in your team's Apollo account.

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

Example: `67e33d527de088000daa60c4`" }, { "name": "contact_id", "value": "", "type": "query", "description": "Designate the contact that was called.

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

Example: `66e34b81740c50074e3d1bd4`" }, { "name": "account_id", "value": "", "type": "query", "description": "Associate the call with an account.

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

Example: `66e9abf95ac32901b20d1a0d`" }, { "name": "to_number", "value": "", "type": "query", "description": "The phone number that you dialed.

Example: `5555550164`" }, { "name": "from_number", "value": "", "type": "query", "description": "The phone number that dialed you.

Example: `5555550164`" }, { "name": "status", "value": "", "type": "query", "description": "The status of the phone call. Possible values include: " }, { "name": "start_time", "value": "", "type": "query", "description": "The time when the call started.

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

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

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`" }, { "name": "end_time", "value": "", "type": "query", "description": "The time when the call ended.

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

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

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

Examples: `120`; `205`" }, { "name": "phone_call_purpose_id", "value": "", "type": "query", "description": "Assign a call purpose to the record.

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

Examples: `6095a710bd01d100a506d4cd`" }, { "name": "phone_call_outcome_id", "value": "", "type": "query", "description": "Assign a call outcome to the record.

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

Examples: `6095a710bd01d100a506d4c5`" }, { "name": "note", "value": "", "type": "query", "description": "Add a note to the call record.

Example: `This lead is interested in learning more about our new product line.`" } ] }, "docs": "## Endpoint essentials\n\n**API key access:** `Master API key`\n\n**OAuth scopes:** `phone_call_write`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Create Call Records endpoint to log calls in Apollo that were made using outside systems such as Orum or Nooks. This endpoint can only be used create call records, not to dial prospects." }, { "info": { "name": "Update Call Records", "type": "http" }, "http": { "method": "PUT", "url": "https://api.apollo.io/api/v1/phone_calls/:id", "params": [ { "name": "logged", "value": "", "type": "query", "description": "Set to `true` if you want to create an individual record for the phone call in Apollo." }, { "name": "user_id[]", "value": "", "type": "query", "description": "Designate the caller in your team's Apollo account.

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

Example: `67e33d527de088000daa60c4`" }, { "name": "contact_id", "value": "", "type": "query", "description": "Designate the contact that was called.

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

Example: `66e34b81740c50074e3d1bd4`" }, { "name": "account_id", "value": "", "type": "query", "description": "Associate the call with an account.

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

Example: `66e9abf95ac32901b20d1a0d`" }, { "name": "to_number", "value": "", "type": "query", "description": "The phone number that you dialed.

Example: `5555550164`" }, { "name": "from_number", "value": "", "type": "query", "description": "The phone number that dialed you.

Example: `5555550164`" }, { "name": "status", "value": "", "type": "query", "description": "The status of the phone call. Possible values include: " }, { "name": "start_time", "value": "", "type": "query", "description": "The time when the call started.

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

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

Example: `2025-02-15T08:10:30Z`; `2025-03-25T10:15:30+05:00Z`" }, { "name": "end_time", "value": "", "type": "query", "description": "The time when the call ended.

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

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

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

Examples: `120`; `205`" }, { "name": "phone_call_purpose_id", "value": "", "type": "query", "description": "Assign a call purpose to the record.

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

Examples: `6095a710bd01d100a506d4cd`" }, { "name": "phone_call_outcome_id", "value": "", "type": "query", "description": "Assign a call outcome to the record.

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

Examples: `6095a710bd01d100a506d4c5`" }, { "name": "note", "value": "", "type": "query", "description": "Add a note to the call record.

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

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

Example: `6859b0dd828b270021e69648`" } ] }, "docs": "## Endpoint essentials\n\n**API key access:** `Master API key`\n\n**OAuth scopes:** `phone_call_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nUse the Update Call Records endpoint to update your team's call records in Apollo." } ] } ], "bundled": true }