# All endpoints

> Every route of the Emelia API on one page, grouped by topic, with a link to its reference page and playground, and the OpenAPI specs to download.

Source: https://docs.emelia.io/docs/all-endpoints

Every route below has its own page, under its topic in the menu: parameters, request body, responses with realistic examples, code in cURL, JavaScript and Python, and a playground to send real requests with your key.

- Emelia API: base URL `https://api.emelia.io`, 114 routes. OpenAPI: https://docs.emelia.io/openapi/emelia.json

The specs are OpenAPI 3.1 files: import them in Postman or Insomnia, generate a client, or give them to an AI agent.

## Emelia API

**Credits**

- [GET /credits/usage](https://docs.emelia.io/docs/credits/list-credit-debits.md): List credit debits

**Campaigns**

- [GET /advanced/campaigns](https://docs.emelia.io/docs/campaigns/list-campaigns.md): List campaigns
- [POST /advanced/campaigns](https://docs.emelia.io/docs/campaigns/create-campaign.md): Create a campaign
- [GET /advanced/campaigns/{campaignId}](https://docs.emelia.io/docs/campaigns/get-campaign.md): Get a campaign
- [PATCH /advanced/campaigns/{campaignId}/steps](https://docs.emelia.io/docs/campaigns/replace-sequence.md): Replace the sequence
- [PATCH /advanced/campaigns/{campaignId}/settings](https://docs.emelia.io/docs/campaigns/update-campaign-settings.md): Update campaign settings
- [PATCH /advanced/campaigns/{campaignId}/identities](https://docs.emelia.io/docs/campaigns/set-sender-identities.md): Set the sender identities
- [PATCH /advanced/campaigns/{campaignId}/recipients](https://docs.emelia.io/docs/campaigns/set-contact-lists.md): Set the contact lists of a campaign
- [POST /advanced/campaigns/{campaignId}/test-email](https://docs.emelia.io/docs/campaigns/send-test-email.md): Send a test email
- [POST /advanced/campaigns/{campaignId}/start](https://docs.emelia.io/docs/campaigns/start-campaign.md): Start a campaign
- [PATCH /advanced/campaigns/{campaignId}/planned-start](https://docs.emelia.io/docs/campaigns/schedule-planned-start.md): Schedule or cancel a planned start
- [POST /advanced/campaigns/{campaignId}/pause](https://docs.emelia.io/docs/campaigns/pause-campaign.md): Pause a campaign
- [POST /advanced/campaigns/{campaignId}/finish](https://docs.emelia.io/docs/campaigns/mark-campaign-as-finished.md): Mark a campaign as finished
- [POST /advanced/campaigns/{campaignId}/reactivate](https://docs.emelia.io/docs/campaigns/reactivate-campaign.md): Reactivate a finished campaign
- [PATCH /advanced/campaigns/{campaignId}/name](https://docs.emelia.io/docs/campaigns/rename-campaign.md): Rename a campaign
- [POST /advanced/campaigns/{campaignId}/duplicate](https://docs.emelia.io/docs/campaigns/duplicate-campaign.md): Duplicate a campaign
- [POST /advanced/campaigns/{campaignId}/archive](https://docs.emelia.io/docs/campaigns/archive-campaign.md): Archive a campaign
- [DELETE /advanced/campaigns/{campaignId}](https://docs.emelia.io/docs/campaigns/delete-campaign.md): Delete a campaign
- [GET /advanced/campaign/contacts](https://docs.emelia.io/docs/campaigns/list-contacts-of-campaign.md): List the contacts of a campaign
- [POST /advanced/campaign/contacts](https://docs.emelia.io/docs/campaigns/add-contact-to-campaign.md): Add a contact to a campaign
- [DELETE /advanced/campaign/contacts](https://docs.emelia.io/docs/campaigns/remove-contact-from-campaign.md): Remove a contact from a campaign
- [PATCH /advanced/contacts](https://docs.emelia.io/docs/campaigns/set-contact-field.md): Set a field on a campaign contact
- [GET /advanced/campaigns/{campaignId}/manual-tasks](https://docs.emelia.io/docs/campaigns/list-pending-manual-tasks.md): List pending manual tasks
- [POST /advanced/campaigns/{campaignId}/manual-tasks/status](https://docs.emelia.io/docs/campaigns/complete-manual-task.md): Complete a manual task
- [GET /advanced/campaigns/{campaignId}/progress](https://docs.emelia.io/docs/campaigns/get-per-step-progress.md): Get per step progress
- [GET /advanced/campaigns/{campaignId}/progress/contacts](https://docs.emelia.io/docs/campaigns/list-contacts-of-step.md): List the contacts of a step
- [GET /advanced/campaigns/{campaignId}/export](https://docs.emelia.io/docs/campaigns/export-as-csv.md): Export campaign data as CSV
- [GET /stats/advanced](https://docs.emelia.io/docs/campaigns/get-campaign-statistics.md): Get campaign statistics
- [POST /advanced/attachments](https://docs.emelia.io/docs/campaigns/upload-message-attachments.md): Upload message attachments
- [POST /advanced/linkedin/audio](https://docs.emelia.io/docs/campaigns/upload-linkedin-voice-note.md): Upload a LinkedIn voice note

**Campaigns / Legacy / Email campaigns**

- [GET /emails/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/email/list-campaign-contacts.md): List email campaign contacts (paginated) (deprecated)
- [POST /emails/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/email/add-contact.md): Add a contact to an email campaign (deprecated)
- [DELETE /emails/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/email/remove-contact.md): Remove a contact from an email campaign (deprecated)
- [POST /emails/lists/contacts](https://docs.emelia.io/docs/campaigns/legacy/email/add-contact-to-list.md): Add a contact to an email list (deprecated)
- [GET /emails/campaigns](https://docs.emelia.io/docs/campaigns/legacy/email/list-campaigns.md): List email campaigns (deprecated)
- [POST /emails/campaigns](https://docs.emelia.io/docs/campaigns/legacy/email/create-campaign.md): Create an email campaign (deprecated)
- [GET /emails/campaigns/{campaignId}](https://docs.emelia.io/docs/campaigns/legacy/email/get-campaign.md): Get email campaign details (deprecated)
- [PATCH /emails/campaigns/{campaignId}/settings/global](https://docs.emelia.io/docs/campaigns/legacy/email/update-schedule.md): Update email campaign schedule (global settings) (deprecated)
- [PATCH /emails/campaigns/{campaignId}/settings/providers](https://docs.emelia.io/docs/campaigns/legacy/email/update-mailboxes.md): Update email campaign sending providers (deprecated)
- [PATCH /emails/campaigns/{campaignId}/name](https://docs.emelia.io/docs/campaigns/legacy/email/rename-campaign.md): Rename an email campaign (deprecated)
- [PATCH /emails/campaigns/{campaignId}/steps](https://docs.emelia.io/docs/campaigns/legacy/email/replace-steps.md): Replace email campaign steps (deprecated)
- [POST /emails/campaigns/{campaignId}/start](https://docs.emelia.io/docs/campaigns/legacy/email/start-campaign.md): Start an email campaign (deprecated)
- [POST /emails/campaigns/{campaignId}/pause](https://docs.emelia.io/docs/campaigns/legacy/email/pause-campaign.md): Pause an email campaign (deprecated)
- [PATCH /emails/contacts](https://docs.emelia.io/docs/campaigns/legacy/email/set-contact-field.md): Set a custom field on an email contact (deprecated)
- [GET /emails/campaigns/{campaignId}/activities](https://docs.emelia.io/docs/campaigns/legacy/email/get-activities.md): Get email campaign activities (deprecated)
- [POST /emails/test](https://docs.emelia.io/docs/campaigns/legacy/email/send-test-email.md): Send a test email (deprecated)
- [GET /stats](https://docs.emelia.io/docs/campaigns/legacy/email/get-statistics.md): Get email campaign statistics (deprecated)

**Campaigns / Legacy / LinkedIn campaigns**

- [GET /linkedin/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/linkedin/list-campaign-contacts.md): List LinkedIn campaign contacts (paginated) (deprecated)
- [POST /linkedin/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/linkedin/add-contact.md): Add a contact to a LinkedIn campaign (deprecated)
- [DELETE /linkedin/campaign/contacts](https://docs.emelia.io/docs/campaigns/legacy/linkedin/remove-contact.md): Remove a contact from a LinkedIn campaign (deprecated)
- [GET /linkedin/campaigns](https://docs.emelia.io/docs/campaigns/legacy/linkedin/list-campaigns.md): List LinkedIn campaigns (deprecated)
- [POST /linkedin/campaigns](https://docs.emelia.io/docs/campaigns/legacy/linkedin/create-campaign.md): Create a LinkedIn campaign (deprecated)
- [PATCH /linkedin/campaigns/{campaignId}/settings/global](https://docs.emelia.io/docs/campaigns/legacy/linkedin/update-schedule.md): Update LinkedIn campaign schedule (global settings) (deprecated)
- [PATCH /linkedin/campaigns/{campaignId}/name](https://docs.emelia.io/docs/campaigns/legacy/linkedin/rename-campaign.md): Rename a LinkedIn campaign (deprecated)
- [PATCH /linkedin/campaigns/{campaignId}/steps](https://docs.emelia.io/docs/campaigns/legacy/linkedin/replace-steps.md): Replace LinkedIn campaign steps (deprecated)
- [GET /linkedin/campaigns/{campaignId}/activities](https://docs.emelia.io/docs/campaigns/legacy/linkedin/get-activities.md): Get LinkedIn campaign activities (deprecated)
- [GET /stats/linkedin](https://docs.emelia.io/docs/campaigns/legacy/linkedin/get-statistics.md): Get LinkedIn campaign statistics (deprecated)

**Lists & contacts**

- [GET /lists/list](https://docs.emelia.io/docs/lists/list-your-lists.md): List your lists
- [POST /lists/list](https://docs.emelia.io/docs/lists/create-list.md): Create a list
- [GET /lists/list/{listId}](https://docs.emelia.io/docs/lists/get-list.md): Get a list
- [PATCH /lists/list/{listId}](https://docs.emelia.io/docs/lists/rename-list.md): Rename a list
- [DELETE /lists/list/{listId}](https://docs.emelia.io/docs/lists/delete-list.md): Delete a list
- [POST /lists/list/export](https://docs.emelia.io/docs/lists/export-lists-as-csv.md): Export lists as CSV
- [GET /lists/list/campaign-usage](https://docs.emelia.io/docs/lists/find-campaigns-of-lists.md): Find the campaigns using lists
- [GET /lists/list/{listId}/rows](https://docs.emelia.io/docs/lists/list-or-find-contacts.md): List or find the contacts of a list
- [DELETE /lists/list/{listId}/rows/{leadId}](https://docs.emelia.io/docs/lists/delete-contact.md): Delete a contact
- [POST /lists/list/{listId}/contacts](https://docs.emelia.io/docs/lists/add-contact.md): Add a contact to a list (add or update)
- [POST /lists/list/{listId}/contacts/batch](https://docs.emelia.io/docs/lists/add-contacts-in-bulk.md): Add up to 100 contacts to a list
- [PATCH /lists/contacts/{contactId}](https://docs.emelia.io/docs/lists/update-contact.md): Update a contact
- [POST /lists/custom-variable](https://docs.emelia.io/docs/lists/create-custom-variable.md): Create a custom variable
- [GET /lists/custom-variable/check](https://docs.emelia.io/docs/lists/check-custom-variable.md): Check whether a custom variable exists
- [GET /lists/list/export/jobs/{jobId}](https://docs.emelia.io/docs/lists/get-status-of-export.md): Get the status of an export
- [GET /lists/list/export/jobs/{jobId}/download](https://docs.emelia.io/docs/lists/download-finished-export.md): Download a finished export

**Enrichment / Email Finder**

- [POST /tools/find/email](https://docs.emelia.io/docs/enrichment/email-finder/find-email.md): Find the email of a person
- [GET /tools/find/email/{jobId}](https://docs.emelia.io/docs/enrichment/email-finder/get-result.md): Get an email search result
- [GET /tools/find/email](https://docs.emelia.io/docs/enrichment/email-finder/list-past-searches.md): List email searches

**Enrichment / Phone Finder**

- [POST /tools/find/phone](https://docs.emelia.io/docs/enrichment/phone-finder/find-phone-number.md): Find the phone number of a person
- [GET /tools/find/phone/{jobId}](https://docs.emelia.io/docs/enrichment/phone-finder/get-result.md): Get a phone search result
- [GET /tools/find/phone](https://docs.emelia.io/docs/enrichment/phone-finder/list-past-searches.md): List phone searches

**Enrichment / Email Verifier**

- [POST /tools/verify/email](https://docs.emelia.io/docs/enrichment/email-verifier/verify-email.md): Verify an email address
- [GET /tools/verify/email/{jobId}](https://docs.emelia.io/docs/enrichment/email-verifier/get-result.md): Get an email verification result
- [GET /tools/verify/email](https://docs.emelia.io/docs/enrichment/email-verifier/list-past-verifications.md): List email verifications

**Replies**

- [GET /advanced/campaigns/{campaignId}/activities](https://docs.emelia.io/docs/replies/list-campaign-activities.md): List campaign activities
- [GET /advanced/campaigns/{campaignId}/activities/{activityId}/message](https://docs.emelia.io/docs/replies/get-sent-message.md): Get the message of a send activity
- [POST /emails/reply](https://docs.emelia.io/docs/replies/send-reply.md): Send a reply from a connected mailbox (deprecated)

**Blacklist**

- [POST /emails/blacklists/contact](https://docs.emelia.io/docs/blacklist/blacklist-email-or-domain.md): Add an email or domain to the account blacklist
- [DELETE /emails/blacklists/contact](https://docs.emelia.io/docs/blacklist/remove-email-or-domain.md): Remove an email or domain from the account blacklist
- [GET /emails/blacklists](https://docs.emelia.io/docs/blacklist/get-blacklists.md): Get the account blacklists
- [POST /emails/blacklists/linkedin](https://docs.emelia.io/docs/blacklist/blacklist-linkedin-profile.md): Add a LinkedIn profile to the blacklist
- [DELETE /emails/blacklists/linkedin](https://docs.emelia.io/docs/blacklist/remove-linkedin-profile.md): Remove a LinkedIn profile from the blacklist

**Webhooks**

- [GET /webhook](https://docs.emelia.io/docs/webhooks/list-webhooks.md): List webhooks
- [Webhook event advancedCampaignActivity](https://docs.emelia.io/docs/webhooks/campaign-activity.md): Activity on an advanced (multichannel) campaign
- [Webhook event campaignEnding](https://docs.emelia.io/docs/webhooks/campaign-finished.md): Campaign finished
- [Webhook event emailCampaignActivity](https://docs.emelia.io/docs/webhooks/legacy-email-activity.md): Activity on a legacy email campaign
- [Webhook event linkedinCampaignActivity](https://docs.emelia.io/docs/webhooks/legacy-linkedin-activity.md): Activity on a legacy LinkedIn campaign

**Email providers**

- [GET /email-providers](https://docs.emelia.io/docs/email-providers/list-email-providers.md): List email providers
- [POST /email-providers](https://docs.emelia.io/docs/email-providers/connect-mailbox.md): Connect an SMTP/IMAP mailbox
- [PATCH /email-providers/{providerId}](https://docs.emelia.io/docs/email-providers/update-mailbox.md): Update an SMTP/IMAP mailbox
- [PATCH /email-providers/{providerId}/sender-name](https://docs.emelia.io/docs/email-providers/change-sender-name.md): Change the sender name
- [DELETE /email-providers/{providerId}](https://docs.emelia.io/docs/email-providers/delete-mailbox.md): Delete a mailbox
- [GET /email-providers/warmup](https://docs.emelia.io/docs/email-providers/list-warmups.md): List warmups
- [POST /email-providers/warmup/enable](https://docs.emelia.io/docs/email-providers/enable-warmup.md): Enable the warmup of a mailbox
- [POST /email-providers/warmup/check-health](https://docs.emelia.io/docs/email-providers/run-deliverability-check.md): Run a deliverability diagnosis

**LinkedIn scraper**

- [POST /linkedin-scrappers](https://docs.emelia.io/docs/linkedin-scraper/start-extraction.md): Create a LinkedIn scraper (start an extraction)
- [GET /linkedin-scrappers](https://docs.emelia.io/docs/linkedin-scraper/list-scrapers.md): List your LinkedIn scrapers
- [GET /linkedin-scrappers/{id}](https://docs.emelia.io/docs/linkedin-scraper/get-scraper.md): Get one LinkedIn scraper (poll its progress)
- [GET /linkedin-scrappers/{id}/download](https://docs.emelia.io/docs/linkedin-scraper/download-csv.md): Download the contacts of a scraper (CSV)
- [POST /linkedin-scrappers/{id}/enrich](https://docs.emelia.io/docs/linkedin-scraper/find-emails.md): Find the emails of a finished scraper
- [POST /linkedin-scrappers/{id}/filter](https://docs.emelia.io/docs/linkedin-scraper/remove-known-contacts.md): Remove contacts already extracted by your other scrapers
- [PUT /linkedin-scrappers/{id}/pause](https://docs.emelia.io/docs/linkedin-scraper/pause-extraction.md): Pause a segmented extraction
- [PUT /linkedin-scrappers/{id}/resume](https://docs.emelia.io/docs/linkedin-scraper/resume-extraction.md): Resume a paused, scheduled or failed scraper
- [POST /linkedin-scrappers/{id}/split](https://docs.emelia.io/docs/linkedin-scraper/split-extraction.md): Detach the part already extracted from a segmented extraction
- [PUT /linkedin-scrappers/{id}/rename](https://docs.emelia.io/docs/linkedin-scraper/rename-scraper.md): Rename a LinkedIn scraper
- [DELETE /linkedin-scrappers/{id}](https://docs.emelia.io/docs/linkedin-scraper/delete-scraper.md): Delete a LinkedIn scraper
- [POST /linkedin-scrappers/{id}/webhook](https://docs.emelia.io/docs/linkedin-scraper/add-webhook.md): Register a webhook on a scraper
- [DELETE /linkedin-scrappers/{id}/webhook](https://docs.emelia.io/docs/linkedin-scraper/remove-webhook.md): Remove a webhook from a scraper
- [POST /linkedin-scrappers/authes](https://docs.emelia.io/docs/linkedin-scraper/connect-account.md): Connect a LinkedIn account for scraping (session cookies)
- [PUT /linkedin-scrappers/authes/{id}](https://docs.emelia.io/docs/linkedin-scraper/refresh-account.md): Refresh the cookies of a connected scraping account