{
"opencollection": "1.0.0",
"info": {
"name": "Apollo.io Contacts API",
"version": "1.0"
},
"request": {
"auth": {
"type": "apikey",
"key": "x-api-key",
"value": "{{x-api-key}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Contacts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a Contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/create` or `Master API key`\n\n**OAuth scopes:** `contact_write`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the Create a Contact endpoint to add a new contact to your team's Apollo account.
By def"
},
{
"info": {
"name": "View a Contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.apollo.io/api/v1/contacts/:contact_id",
"params": [
{
"name": "contact_id",
"value": "",
"type": "path",
"description": "The Apollo ID for the contact that you want to view.
To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.
Example: `66e34b81740c50074e3d1bd4`"
}
]
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/show` or `Master API key`\n\n**OAuth scopes:** `contact_read`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the View a Contact endpoint to retrieve details for an existing contact in your team's Apollo datab"
},
{
"info": {
"name": "Update a Contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.apollo.io/api/v1/contacts/:contact_id",
"params": [
{
"name": "contact_id",
"value": "",
"type": "path",
"description": "The Apollo ID for the contact that you want to update.
To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.
Example: `66e34b81740c50074e3d1bd4`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/update` or `Master API key`\n\n**OAuth scopes:** `contact_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the Update a Contact endpoint to update existing contacts in your team's Apollo account.
Example: 64a7ff0cc4dfae00013df1a5"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `deals/api/v1/opportunities/search` or `Master API key`\n\n**OAuth scopes:** `opportunities_list`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nDeals on Apollo help you track sales opportunities.
Use the View Associated Deals endpoint to retrieve the deals associated with "
},
{
"info": {
"name": "Search for Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/search` or `Master API key`\n\n**OAuth scopes:** `contacts_search`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the Search for Contacts endpoint to search for the contacts that have been added to your team'"
},
{
"info": {
"name": "Update Contact Stage for Multiple Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts/update_stages",
"params": [
{
"name": "contact_ids[]",
"value": "",
"type": "query",
"description": "The Apollo IDs for the contacts that you want to update.
To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.
Example: `66e34b81740c50074e3d1bd4`"
},
{
"name": "contact_stage_id",
"value": "",
"type": "query",
"description": "The Apollo ID for the contact stage to which you want to assign the contacts. Call the List Contact Stages endpoint to retrieve a list of all the contact stage IDs available in your Apollo account.
Example: `6095a710bd01d100a506d4af`"
}
]
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/update_stages` or `Master API key`\n\n**OAuth scopes:** `contact_stages_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact stages help you track progress on sales and marketing pipelines.
Use the Update Contact Stage for Mul"
},
{
"info": {
"name": "Update Contact Owner for Multiple Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts/update_owners",
"params": [
{
"name": "contact_ids[]",
"value": "",
"type": "query",
"description": "The Apollo IDs for the contacts that you want assign to an owner.
To find contact IDs, call the Search for Contacts endpoint and identify the `id` value for the contact.
Example: `66e34b81740c50074e3d1bd4`"
},
{
"name": "owner_id",
"value": "",
"type": "query",
"description": "The ID for the contact owner within your team's Apollo account. This user will be assigned ownership of the contacts.
Use the Get a List of Users endpoint endpoint to retrieve IDs for all of the users within your Apollo account.
Example: `66302798d03b9601c7934ebf`"
}
]
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/update_owners` or `Master API key`\n\n**OAuth scopes:** `contact_owners_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact owners manage specific contacts in Apollo.
Use the Update Contact Owner for Multiple Contacts endpoint to"
},
{
"info": {
"name": "Bulk Create Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts/bulk_create",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/bulk_create` or `Master API key`\n\n**OAuth scopes:** `contacts_bulk_create`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the Bulk Create Contacts endpoint to create up to 100 contacts in a single API reque"
},
{
"info": {
"name": "Bulk Update Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.apollo.io/api/v1/contacts/bulk_update",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contacts/bulk_update` or `Master API key`\n\n**OAuth scopes:** `contacts_bulk_update`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContacts are people saved in Apollo.
Use the Bulk Update Contacts endpoint to update multiple contacts in your team's Apollo "
},
{
"info": {
"name": "List Contact Stages",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.apollo.io/api/v1/contact_stages"
},
"docs": "## Endpoint essentials\n\n**API key access:** `api/v1/contact_stages/index` or `Master API key`\n\n**OAuth scopes:** `contact_stages_list`\n\n**Credit usage:** `0 credits` — [Learn more about API pricing and credits](https://docs.apollo.io/docs/api-pricing).\n\nContact stages help you track progress on sales and marketing pipelines.
Use the List Contact Stages endpoint to "
}
]
}
],
"bundled": true
}