In short: the Magileads API V2 (version 2.0.0, OpenAPI 3.0 specification) is the REST API for the Magileads B2B multichannel prospecting platform. It exposes 505 endpoints divided into 47 groups, accessible at https://app.api-magileads.net with a key passed in the x-api-key header . It allows you to automate the entire lead generation cycle: LinkedIn, Sales Navigator, and Google Maps targeting; email and phone enrichment; email, LinkedIn, and SMS campaigns; PRM; statistics; and white labeling.
This page is the complete reference for the Magileads V2 API. It is aimed at developers, integrators, Growth Ops and agencies who want to connect Magileads to their CRM, their no-code tools or their back office, and industrialize B2B prospecting without going through the interface.
The application: application.magileads.io or the website magileads.com
Magileads V2 API Technical Specifications
| Name | Magileads API |
|---|---|
| Version | 2.0.0 |
| Specification | OpenAPI 3.0 (OAS 3.0), swagger.json |
| Kind | REST API, JSON responses |
| base URL | https://app.api-magileads.net |
| Authentication | API key ( x-api-key header ) or OAuth 2.0 |
| Time zone | All dates are in GMT |
| Volume | 505 endpoints, 47 groups: 154 GET, 200 POST, 82 PUT, 69 DELETE |
| Support | co*****@*******ds.eu |
Distribution of endpoints by functional domain
| Domain | Groups | Endpoints |
|---|---|---|
| Access, authentication and security | API Information, API Keys, OAuth 2.0, Permissions, Roles, External Magileads V2 API Keys | 31 |
| Users, organizations, and subscriptions | Users, Organizations, Teams, Subscriptions and Billing, Affiliate Programs, Notifications, User Feedback | 73 |
| B2B lead targeting and extraction | LinkedIn and Sales Navigator targeting, Google Maps targeting, database targeting | 35 |
| Contact data, enrichment and compliance | Contact lists, Data fields, Batch enrichment, Blacklists, Unsubscribers, Tags | 60 |
| Messages, models, and AI agents | AI agents, Email templates, LinkedIn invitation templates, LinkedIn message templates, SMS templates, SMV templates, Email signatures | 62 |
| Multichannel campaigns (workflows) | Workflows and scheduling, Jobs, Integration pools, URL shortener, Forms | 62 |
| Sending channels and deliverability | Email integrations, LinkedIn integrations, OVH (domains and emails) | 33 |
| PRM: CRM for prospecting | PRM | 57 |
| Statistics and reporting | Statistics, Reports | 26 |
| Automation and third-party integrations | Webhooks, Zapier, Crons | 22 |
| White label (resellers) | Resellers, Resellers: Mailgun | 33 |
| Files and folders | Files, Folders | 11 |
Magileads V2 API Authentication
Two mechanisms coexist:
- API key : Each request carries the
x-api-keyheader . Keys are managed via the API (/api-keys): generation, regeneration, and deletion. This method is suitable for server scripts and internal integrations. - OAuth 2.0 : for third-party applications acting on behalf of a user. The authorization server is discovered via
GET /.well-known/oauth-authorization-serverand supports authorization code streaming, dynamic client registration, token refresh, and token revocation.
Security best practice: the API key grants access to all account data. Never expose it in the browser, in a shared URL, or in a code repository. In case of a leak, regenerate it immediately with PUT /api-keys/{api_key_id}/regenerate.
Quick start: first call
The first recommended call is GET /users/me, which returns the profile of the account associated with the key and validates the configuration.
With cURL
curl -X GET "https://app.api-magileads.net/users/me" \ -H "accept: application/json" \ -H "x-api-key: YOUR_API_KEY"In PHP (WordPress)
<?php declare(strict_types=1); /** * Récupère le profil du compte Magileads associé à la clé d’API. * La clé est lue depuis une constante définie dans wp-config.php, jamais en base ni en dur. * * @return array<string, mixed> |WP_Error */ function magileads_get_my_profile(): array|WP_Error { if ( ! defined( 'MAGILEADS_API_KEY' ) ) { return new WP_Error( 'magileads_no_key', 'MAGILEADS_API_KEY constant missing.' ); } $response = wp_remote_get( 'https://app.api-magileads.net/users/me', array( 'timeout' => 15, 'headers' => array( 'Accept' => 'application/json', 'x-api-key' => (string) MAGILEADS_API_KEY, ), ) ); if ( is_wp_error( $response ) ) { return $response; } $code = (int) wp_remote_retrieve_response_code( $response ); if ( 200 !== $code ) { return new WP_Error( 'magileads_http_' . $code, 'Unexpected HTTP response.' ); } $data = json_decode( wp_remote_retrieve_body( $response ), true ); return is_array( $data ) ? $data: new WP_Error('magileads_json', 'Invalid JSON.'); }Using JavaScript (Node.js, server-side only)
// Server-side call: the key remains in an environment variable. const res = await fetch("https://app.api-magileads.net/users/me", { headers: { accept: "application/json", "x-api-key": process.env.MAGILEADS_API_KEY } }); if (!res.ok) throw new Error(`Magileads API : HTTP ${res.status}`); const profile = await res.json();Magileads V2 API use cases
1. Build a qualified B2B audience
The Targeting – LinkedIn , Targeting – Google and Targeting – Database endpoints populate contact lists from Sales Navigator searches, engagements on LinkedIn posts, profile visitors or Google Maps listings.
2. Enrich and clean the data
Enrich bundles and email and mobile enrichment endpoints complement the records. Blacklists and unsubscribes are applied directly to the lists to comply with GDPR before any mailing.
3. Launch AI-powered custom multi-channel sequences
Email templates , invitations and LinkedIn messages are generated by AI and then assembled in a workflow , programmed on sending accounts grouped into pools with SMTP warmup.
4. Process the responses in the PRM
The PRM centralizes respondents: positive or negative qualification, AI-powered answer suggestion, notes, calls, personalized statuses, and nurturing.
5. Measure and synchronize
The statistics analyze respondents by sector, company size, country, or channel. Webhooks and Zapier push events to the CRM.
Complete reference to the 505 endpoints of the Magileads V2 API
The endpoints are grouped by functional domain. The segments between curly braces (for example, {contact_list_id}) are path parameters. {file_type} designates the requested export format. The descriptions use the official labels from the OpenAPI specification.
Access, authentication and security
Entry points that control access to the API: API keys, OAuth 2.0 authorization server, roles, permissions and API keys of third-party services. 31 endpoints.
API Information
Returns API metadata, globally or for a given SaaS domain (white-label instance). 2 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api | API information |
| GET | /api/{saas_domain} | API information |
API Keys
Complete lifecycle of API keys (tokens): generation, update, regeneration, and revocation. Regeneration invalidates the old key. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api-keys | Fetch list |
| GET | /api-keys/{api_key_id} | Find profile |
| POST | /api-keys | Generate an API Key (token) |
| PUT | /api-keys/{api_key_id} | Update profile |
| PUT | /api-keys/{api_key_id}/regenerate | Regenerate an API Key (token) |
| DELETE | /api-keys/{api_key_id} | Delete an API Key |
OAuth 2.0 OAuth
OAuth 2.0 compliant authorization server: discovery via /.well-known/oauth-authorization-server, authorization code stream, dynamic client registration, token exchange and refresh, revocation and JWKS signing keys. 8 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /.well-known/oauth-authorization-server | Discover the OAuth authorization server |
| GET | /oauth/authorization-transactions/{transaction_id} | Fetch an OAuth consent transaction |
| GET | /oauth/authorize | Start an authorization-code flow |
| GET | /oauth/jwks.json | Fetch OAuth signing keys |
| POST | /oauth/authorization-transactions/{transaction_id} | Approve or deny an OAuth consent transaction |
| POST | /oauth/register | Register an OAuth client dynamically |
| POST | /oauth/revoke | Revoke an OAuth token |
| POST | /oauth/token | Exchange or refresh OAuth tokens |
Permissions Permissions
Reading and modifying, individually or in batches, the permissions granted to each user. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /permissions | Fetch list |
| GET | /permissions/{user_id} | Fetch list of a user |
| PUT | /permissions/{permission_name}/{user_id} | Update a user permission |
| PUT | /permissions/{user_id} | Batch update user permissions |
| DELETE | /permissions/{permission_name}/{user_id} | Delete a permission |
Roles
Creation and management of roles that group user rights. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /roles | Fetch list |
| GET | /roles/{role_id} | Find profile |
| POST | /roles | Create a role |
| PUT | /roles/{role_id} | Update profile |
| DELETE | /roles/{role_id} | Delete a role |
External API keys
Storage of third-party service keys (enrichment providers, OVH, etc.) subsequently used by other endpoints via {external_api_key_id}. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /external-api-keys | Fetch list |
| GET | /external-api-keys/{external_api_key_id} | Find profile |
| POST | /external-api-keys | Add profile |
| PUT | /external-api-keys/{external_api_key_id} | Update profile |
| DELETE | /external-api-keys/{external_api_key_id} | Delete profile |
Users, organizations, and subscriptions
User account management, organization management, team management, billing management, and notification management. 73 endpoints.
Users
Registration, authentication (with refresh), login via third-party providers, current profile (/users/me), avatar, password, SMS verification, switching between accounts and generation of an embedded search token. 26 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /users/{user_id} | Find profile by ID |
| GET | /users/list | Retrieve the list of users |
| GET | /users/me | Find my profile |
| GET | /users/me/quick | Find my profile (quick version) |
| POST | /oauth/{provider}/redirect | Register or login using third party logins |
| POST | /users/{user_id}/avatar | Upload an avatar to a user account |
| POST | /users/authentication | Authentication |
| POST | /users/authentication/refresh | Refresh authentication |
| POST | /users/list/search | Search users |
| POST | /users/me/avatar | Upload an avatar to my user account |
| POST | /users/me/embed/search-list/token | Generate an embedded search token |
| POST | /users/register | Register |
| POST | /users/switch/to/{user_id} | Switch to a user account |
| POST | /users/verification/sms/resend | Resend SMS verification code |
| PUT | /users/{user_id} | Update profile by ID |
| PUT | /users/{user_id}/disable | Disable by ID |
| PUT | /users/me | Update my profile |
| PUT | /users/me/disable | Disable |
| PUT | /users/password/forgot | Forgot password |
| PUT | /users/password/reset | Reset password |
| PUT | /users/unlock | Unlock user account |
| PUT | /users/verification/sms/confirm | Confirm account via SMS code |
| DELETE | /users/{user_id} | Delete a user account |
| DELETE | /users/{user_id}/avatar | Delete the avatar of a user account |
| DELETE | /users/me | Delete my user account |
| DELETE | /users/me/avatar | Delete the avatar from my user account |
Organizations
Organization creation, user invitation and membership, member level and role management. 11 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /organizations | Fetch list |
| GET | /organizations/{organization_id} | Find profile |
| GET | /organizations/{organization_id}/users | Fetch users list |
| POST | /organizations | Create an organization |
| POST | /organizations/{organization_id}/invite | Invite a user to an organization |
| POST | /organizations/join | Join an organization |
| PUT | /organizations/{organization_id} | Update profile |
| PUT | /organizations/{organization_id}/level/{user_id} | Update the user's level |
| PUT | /organizations/{organization_id}/role/{user_id} | Update the role of a user |
| DELETE | /organizations/{organization_id} | Delete an organization |
| DELETE | /organizations/{organization_id}/leave | Leave an organization |
Teams
Teams within an account: invitations, membership, member levels and roles. 10 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /teams/{team_id} | Find profile |
| GET | /teams/{team_id}/users | Fetch users list |
| POST | /teams | Create a team |
| POST | /teams/{team_id}/invite | Invite a user to a team |
| POST | /teams/join | Join a team |
| PUT | /teams/{team_id} | Update profile |
| PUT | /teams/{team_id}/level/{user_id} | Update the user's level |
| PUT | /teams/{team_id}/role/{user_id} | Update the role of a user |
| DELETE | /teams/{team_id} | Delete a team |
| DELETE | /teams/{team_id}/leave | Leave a team |
Subscriptions and Billing
Products, subscription and cancellation, subscription options, payment methods, customer information and invoice downloads. 12 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /subscriptions/invoices | Fetch client invoices list |
| GET | /subscriptions/invoices/download/{invoice_id} | Download client invoice |
| GET | /subscriptions/products | Fetch products list |
| POST | /subscriptions/add/payment-method | Add and set default payment method |
| POST | /subscriptions/subscribe | Subscribe |
| POST | /subscriptions/subscribe/{user_id} | Subscribe |
| POST | /subscriptions/update/customer-info | Update customer information |
| POST | /subscriptions/update/default-payment-method | Update the default payment method |
| PUT | /subscriptions/add/options | Add Subscription Options |
| DELETE | /subscriptions/remove/options | Remove Subscription Options |
| DELETE | /subscriptions/unsubscribe | Unsubscribe |
| DELETE | /subscriptions/unsubscribe/{user_id} | Unsubscribe |
Affiliation Affiliation
List of users associated with the affiliate program. 1 endpoint.
| Method | Endpoint | Description |
|---|---|---|
| GET | /affiliation/users | Fetch users list |
Notifications
Account notifications and alerts: read receipts, read/unread marking, hiding, and notification settings. 12 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /notifications | Fetch notifications |
| GET | /notifications/alerts | Fetch account alerts |
| GET | /notifications/settings | Fetch notification settings |
| PUT | /notifications/alerts/hide | Hide an account alert |
| PUT | /notifications/alerts/unhide | Unhide an account alert |
| PUT | /notifications/hide | Hide notifications |
| PUT | /notifications/hide-all | Hide all notifications |
| PUT | /notifications/read | Mark notifications as read |
| PUT | /notifications/read-all | Mark all notifications as read |
| PUT | /notifications/settings | Update notification settings |
| PUT | /notifications/unhide | Unhide notifications |
| PUT | /notifications/unread | Mark notifications as unread |
User feedback
Sending feedback to the Magileads team. 1 endpoint.
| Method | Endpoint | Description |
|---|---|---|
| POST | /feedbacks | Send feedback |
B2B lead targeting and extraction
Lead generation: extraction of contacts and companies from LinkedIn, Sales Navigator, Google Maps and the Magileads database. 35 endpoints.
LinkedIn Targeting and Sales Navigator Targeting – LinkedIn
Extraction of profiles and companies from LinkedIn and Sales Navigator searches (asynchronous, synchronous, and alternate modes), connections, group members, event attendees, profile or company page visitors, post interactions (likes, comments, shares), profile activity, and job postings. Includes search URL generation and location ID retrieval. 27 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| POST | /targeting/linkedin/{contact_list_id}/relaunch-errors | Relaunch LinkedIn extractions with errors |
| POST | /targeting/linkedin/extract-companies-search-sync | Extract LinkedIn companies from a company search (synchronous) |
| POST | /targeting/linkedin/extract-company-viewers | Extract LinkedIn company viewers |
| POST | /targeting/linkedin/extract-connections | Extract contacts from LinkedIn connections |
| POST | /targeting/linkedin/extract-event-attendees | Extract LinkedIn event attendees |
| POST | /targeting/linkedin/extract-group-members | Extract LinkedIn group members |
| POST | /targeting/linkedin/extract-people-comment-activity | Extract LinkedIn people comment activity |
| POST | /targeting/linkedin/extract-people-post-activity | Extract LinkedIn people post activity |
| POST | /targeting/linkedin/extract-people-reaction-activity | Extract LinkedIn people reaction activity |
| POST | /targeting/linkedin/extract-peoples-search | Extract contacts from a LinkedIn search |
| POST | /targeting/linkedin/extract-peoples-search-alternative | Extract contacts from a LinkedIn search (alternative) |
| POST | /targeting/linkedin/extract-peoples-search-sync | Extract LinkedIn profiles from a people search (synchronous) |
| POST | /targeting/linkedin/extract-post-commenters | Extract contacts who commented on a LinkedIn post |
| POST | /targeting/linkedin/extract-post-likers | Extract contacts who liked a post on LinkedIn |
| POST | /targeting/linkedin/extract-post-reposters | Extract LinkedIn post reposters |
| POST | /targeting/linkedin/extract-posts | Extract posts on LinkedIn |
| POST | /targeting/linkedin/extract-posts-sync | Extract LinkedIn posts (synchronous) |
| POST | /targeting/linkedin/extract-profile-viewers | Extract LinkedIn profile viewers |
| POST | /targeting/linkedin/extract-publishers-job-offers | Extract the publishers of job offers on LinkedIn |
| POST | /targeting/linkedin/extract-sales-navigator-companies-search | Extract companies from a Sales Navigator search |
| POST | /targeting/linkedin/extract-sales-navigator-companies-search-alternative | Extract companies from a Sales Navigator search (alternative) |
| POST | /targeting/linkedin/extract-sales-navigator-peoples-search | Extract contacts from a Sales Navigator search |
| POST | /targeting/linkedin/extract-sales-navigator-peoples-search-alternative | Extract contacts from a Sales Navigator search (alternative) |
| POST | /targeting/linkedin/generate-peoples-search-url | Generate a Linkedin peoples search url |
| POST | /targeting/linkedin/generate-sales-navigator-peoples-search-url | Generate a Linkedin Sales Navigator peoples search url |
| POST | /targeting/linkedin/locations/search | Search LinkedIn location IDs |
| POST | /targeting/linkedin/refresh/{contact_list_id} | Refresh LinkedIn targeting on a contact list |
Targeting Google Maps Targeting – Google
Extraction of businesses and contacts from Google Maps searches, generation of search URLs and retrieval of extractions (including those with errors). 4 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| POST | /targeting/google/extract-maps-search | Extract contacts from a Google Maps Search |
| POST | /targeting/google/extract-maps-search/{contact_list_id}/relaunch | Relaunch extractions |
| POST | /targeting/google/extract-maps-search/{contact_list_id}/relaunch-errors | Relaunch extractions with errors |
| POST | /targeting/google/generate-maps-search-urls | Generate Google Maps Search URLs |
Database Targeting
Counting, previewing and extracting contacts from the Magileads database using filters, with location search. 4 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| POST | /targeting/database/count | Count the number of contacts found with the given filters |
| POST | /targeting/database/count-preview | Count and preview contacts based on filters |
| POST | /targeting/database/extract | Extract contacts found with the given filters |
| POST | /targeting/database/locations/search | Search database location |
Contact data, enrichment and compliance
Storage, structuring and enrichment of contacts, plus the exclusion lists essential for GDPR compliance. 60 endpoints.
Contact Lists
Contact lists and individual contacts: pagination, cross-search, merging, export by file type, unique values, and bulk field updates. Advanced cleanup: removal of contacts from a blacklist, another list, or unsubscribed contacts, and limitation of the number of contacts per company. Email and mobile enrichment. 26 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /contact-lists | Fetch all lists |
| GET | /contact-lists-paginated | Fetch paginated list |
| GET | /contact-lists/{contact_list_id} | Find profile |
| GET | /contact-lists/{contact_list_id}/contacts | Fetch contacts |
| GET | /contact-lists/{contact_list_id}/contacts/{contact_id} | Find contact profile |
| GET | /contact-lists/{contact_list_id}/datafields/{datafield_id}/values | Get unique values from a datafield |
| GET | /contact-lists/{contact_list_id}/download/{file_type} | Download the list of contacts |
| GET | /contact-lists/names | Fetch contact list IDs and names |
| POST | /contact-lists/contacts/search | Search contacts in all contact list |
| POST | /contact-lists/download/{file_type} | Download the list of contacts from all contact lists |
| POST | /contact-lists/merge | Merge contact lists |
| POST | /contacts/enrich/email | Enrich a contact email from company and optional names |
| POST | /contacts/enrich/phone/mobile | Enrich a contact mobile phone from LinkedIn URL |
| PUT | /contact-lists/{contact_list_id} | Update profile |
| PUT | /contact-lists/{contact_list_id}/contacts/{contact_id} | Update contact |
| PUT | /contact-lists/{contact_list_id}/datafields/{datafield_id}/bulk-set | Bulk set datafield value |
| DELETE | /contact-lists/{contact_list_id} | Delete a contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts | Delete contacts from a contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts/{contact_id} | Delete Contact |
| DELETE | /contact-lists/{contact_list_id}/contacts/blacklist/{blacklist_id} | Delete contacts from a contact list found in a blacklist |
| DELETE | /contact-lists/{contact_list_id}/contacts/contact-list/{source_contact_list_id} | Delete contacts from a contact list found in another contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts/unsubscribers | Delete contacts from a contact list found in unsubscribers |
| DELETE | /contact-lists/{contact_list_id}/contacts/unsubscribers/{organization_id} | Delete contacts from a contact list found in unsubscribers from an organization |
| DELETE | /contact-lists/{contact_list_id}/delete/company/{keep_contacts} | Delete contacts on a contact list to keep only a certain amount of contacts by company |
| DELETE | /contact-lists/contacts | Delete Contacts |
| DELETE | /contact-lists/contacts/selection | Delete Contacts from a selection |
Data Fields
Custom fields (data fields) attached to contacts. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /data-fields | Fetch list |
| GET | /data-fields/{data_field_id} | Find profile |
| POST | /data-fields | Create a data field |
| PUT | /data-fields/{data_field_id} | Update profile |
| DELETE | /data-fields/{data_field_id} | Delete a data field |
Batch Enrichment
Creation of enrichment batches, retrieval of results and consumption statistics. 3 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /enrich/{batch_id} | Get enriched batch results |
| POST | /enrich | Create an enriched batch |
| POST | /enrich/usage | Get enriched usage statistics |
Blacklists
Exclusion lists: creation, data import, targeted or global search, download (with or without filter) and data deletion. 13 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /blacklists | Fetch list |
| GET | /blacklists/{blacklist_id} | Find profile |
| GET | /blacklists/{blacklist_id}/data | Fetch data |
| GET | /blacklists/{blacklist_id}/download/{file_type} | Download the blacklist |
| POST | /blacklists | Create a blacklist |
| POST | /blacklists/{blacklist_id}/data | Import data |
| POST | /blacklists/{blacklist_id}/data/search | Search data in specific blacklist |
| POST | /blacklists/{blacklist_id}/download/{file_type} | Download the blacklist using a filter |
| POST | /blacklists/data/search | Search data in all blacklist |
| PUT | /blacklists/{blacklist_id} | Update profile |
| DELETE | /blacklists/{blacklist_id} | Delete a blacklist |
| DELETE | /blacklists/{blacklist_id}/data/{data_id} | Delete Data |
| DELETE | /blacklists/datas | Delete Data |
Unsubscribers
Global or organizational unsubscription management: import, search, download and delete. 8 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /unsubscribers | Fetch unsubscribers |
| GET | /unsubscribers/download/{file_type} | Download the list of unsubscribers |
| GET | /unsubscribers/organization/{organization_id} | Retrieve unsubscribers from an organization |
| GET | /unsubscribers/organization/{organization_id}/download/{file_type} | Download the list of unsubscribers from an organization |
| POST | /unsubscribers | Import unsubscribers |
| POST | /unsubscribers/organization/{organization_id}/search | Search unsubscribers from specific organization |
| POST | /unsubscribers/search | Search unsubscribers from all organizations |
| DELETE | /unsubscribers/{unsubscriber_id} | Delete an unsubscriber |
Tags Tags
Reusable labels for segmenting contacts. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /tags | Fetch list |
| GET | /tags/{tag_id} | Find profile |
| POST | /tags | Create a tag |
| PUT | /tags/{tag_id} | Update profile |
| DELETE | /tags/{tag_id} | Delete a tag |
Messages, models, and AI agents
Message templates for each channel and AI agents tasked with writing and personalizing campaign content. 62 endpoints.
AI Agents (AiAgents)
Creation and management of AI agents, generation of a brief from an existing agent or without an agent. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /ai-agents | Fetch AI agents |
| GET | /ai-agents/{uniqid} | Find AI agent by uniqid |
| POST | /ai-agents | Create AI agent |
| POST | /ai-agents/{uniqid}/generate-brief | Generate AI agent brief |
| POST | /ai-agents/generate-brief | Generate AI agent brief without an existing agent |
| PUT | /ai-agents/{uniqid} | Update AI agent |
| DELETE | /ai-agents/{uniqid} | Delete AI agent |
Email Templates – Email
Email templates: AI-powered generation and regeneration (text and HTML), personalization by contact, importing HTML from a URL, copying between accounts, and sending tests. 15 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /models/email | Fetch list |
| GET | /models/email/{model_id} | Find profile |
| GET | /models/email/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/email/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/email | Create an email template |
| POST | /models/email/{model_id}/copy | Copy an email template |
| POST | /models/email/{model_id}/copy/to/{user_id} | Copy an email template to user ID |
| POST | /models/email/{model_id}/regenerate | Regenerate an email model using AI |
| POST | /models/email/{model_id}/send/test | Send an email campaign on your test emails |
| POST | /models/email/generate | Generate an email model using AI |
| POST | /models/email/generate/html | Generate HTML email using AI |
| POST | /models/email/get/html/from/url | Get HTML from URL |
| POST | /models/email/send/test | Send an email campaign on your test emails without creating a model |
| PUT | /models/email/{model_id} | Update an email template |
| DELETE | /models/email/{model_id} | Delete an email template |
LinkedIn Invitation Templates – LinkedIn Invitation
LinkedIn connection request templates, with AI-powered content generation and personalization per contact. 10 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /models/linkedin/invitation | Fetch list |
| GET | /models/linkedin/invitation/{model_id} | Find profile |
| GET | /models/linkedin/invitation/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/linkedin/invitation/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/linkedin/invitation | Create a LinkedIn invitation |
| POST | /models/linkedin/invitation/{model_id}/copy | Copy a LinkedIn invitation |
| POST | /models/linkedin/invitation/{model_id}/copy/to/{user_id} | Copy a LinkedIn invitation to user ID |
| POST | /models/linkedin/invitation/generate/content | Generate LinkedIn invitation content using AI |
| PUT | /models/linkedin/invitation/{model_id} | Update a LinkedIn invitation |
| DELETE | /models/linkedin/invitation/{model_id} | Delete a LinkedIn invitation |
LinkedIn Message Templates – LinkedIn Message
LinkedIn message templates, with AI-powered content generation and personalization per contact. 10 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /models/linkedin/message | Fetch list |
| GET | /models/linkedin/message/{model_id} | Find profile |
| GET | /models/linkedin/message/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/linkedin/message/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/linkedin/message | Create a LinkedIn message |
| POST | /models/linkedin/message/{model_id}/copy | Copy a LinkedIn message |
| POST | /models/linkedin/message/{model_id}/copy/to/{user_id} | Copy a LinkedIn message to user ID |
| POST | /models/linkedin/message/generate/content | Generate LinkedIn message content using AI |
| PUT | /models/linkedin/message/{model_id} | Update a LinkedIn message |
| DELETE | /models/linkedin/message/{model_id} | Delete a LinkedIn message |
SMS Templates – SMS
SMS templates: creation, copying (including to another user), updating and deletion. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /models/sms | Fetch list |
| GET | /models/sms/{model_id} | Find profile |
| POST | /models/sms | Create an SMS model |
| POST | /models/sms/{model_id}/copy | Copy an SMS template |
| POST | /models/sms/{model_id}/copy/to/{user_id} | Copy an SMS template to user ID |
| PUT | /models/sms/{model_id} | Update an SMS model |
| DELETE | /models/sms/{model_id} | Delete an SMS model |
SMV Models – SMV
SMV templates: creation, update, copy (including to another user) and deletion. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /models/smv | Fetch list |
| GET | /models/smv/{model_id} | Find profile |
| POST | /models/smv | Create a SMV model |
| POST | /models/smv/{model_id} | Update a SMV model |
| POST | /models/smv/{model_id}/copy | Copy a SMV model |
| POST | /models/smv/{model_id}/copy/to/{user_id} | Copy an SMV model to user ID |
| DELETE | /models/smv/{model_id} | Delete a SMV model |
Email Signatures Email Signatures
Reusable email signatures in campaigns. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /email-signatures | Fetch list |
| GET | /email-signatures/{email_signature_id} | Find profile |
| POST | /email-signatures | Create an email signature |
| POST | /email-signatures/{email_signature_id}/copy | Copy an email signature |
| PUT | /email-signatures/{email_signature_id} | Update profile |
| DELETE | /email-signatures/{email_signature_id} | Delete an email signature |
Multichannel campaigns (workflows)
Orchestration of multichannel prospecting sequences and their execution. 62 endpoints.
Workflows and scheduling
Core automation: creation, copying and scheduling of workflows, control of schedules (stop, resume, archive, step by step), contacts by step and by type (export, copy to a list, add to blacklist), clickers by link, exclusions, sending of individual emails, downloading of EML and generation of workflows by AI agent (jobs, preview, readiness assessment, regeneration). 39 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /workflows | Fetch list |
| GET | /workflows/{workflow_id} | Find profile |
| GET | /workflows/{workflow_id}/programming/{workflow_programming_id} | Find a workflow programming |
| GET | /workflows/{workflow_id}/programming/{workflow_programming_id}/{contact_type} | Get contacts by workflow programming and type |
| GET | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/{contact_type} | Get contacts by workflow programming step and type |
| GET | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/click/link/{link_url} | Get clicker contacts by workflow programming step and type and link |
| GET | /workflows/{workflow_id}/programming | Fetch workflow schedules by workflow id |
| GET | /workflows/ai-agent/jobs | Fetch AI agent workflow generation jobs |
| GET | /workflows/ai-agent/jobs/{job_uniqid} | Fetch AI agent workflow generation status |
| GET | /workflows/exclude/programmation/{programmation_id} | List exclusions of contacts from a programming |
| GET | /workflows/programmations | Fetch workflow schedules |
| GET | /workflows/programs/contacts | Fetch workflow contact programming |
| GET | /workflows/reply/email/{reply_id}/download/eml | Download the eml of an email reply |
| GET | /workflows/sent/email/{id}/download/eml | Download the eml of an email manually sent |
| POST | /workflows | Create a workflow |
| POST | /workflows/{workflow_id}/copy | Copy a workflow |
| POST | /workflows/{workflow_id}/copy/to/{user_id} | Copy a workflow to user ID |
| POST | /workflows/{workflow_id}/image | Upload workflow image |
| POST | /workflows/{workflow_id}/program | Program a workflow |
| POST | /workflows/{workflow_id}/programming/{workflow_programming_id}/{contact_type}/{file_type} | Download contacts by workflow programming and type |
| POST | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/{contact_type}/{file_type} | Download contacts by workflow programming step and type |
| POST | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/{contact_type}/blacklist/{blacklist_id} | Blacklist contacts by workflow programming step and type |
| POST | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/{contact_type}/copy-to/{contact_list_id_destination} | Copy contacts of a workflow programming step and type to a contact list |
| POST | /workflows/{workflow_id}/readiness | Evaluate AI agent workflow readiness |
| POST | /workflows/ai-agent | Queue AI agent workflow draft generation |
| POST | /workflows/ai-agent/jobs/{job_uniqid}/contact-preview | Generate grouped AI agent contact previews |
| POST | /workflows/ai-agent/regenerate | Regenerate an AI campaign message or workflow |
| POST | /workflows/send/email | Send a single email |
| POST | /workflows/send/email-with-attachments | Send a single email with attachments |
| PUT | /workflows/{workflow_id} | Update profile |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id} | Update programming profile |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/archive | Archive a programming workflow |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/resume | Summary of a programming workflow |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/resume | Summary a workflow programming step |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/step/{step_id}/stop | Stop a workflow programming step |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/stop | Stop a workflow programming |
| PUT | /workflows/{workflow_id}/programming/{workflow_programming_id}/unarchive | Unarchive a programming workflow |
| DELETE | /workflows/{workflow_id} | Delete a workflow |
| DELETE | /workflows/exclude/programming/{exclusion_id} | Remove exclusion of a contact from a programming |
Jobs Jobs
Monitoring and stopping asynchronous tasks, deleting failed results. 3 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /jobs/prm/{target_id} | List of PRM jobs |
| DELETE | /jobs/{job_uniqid} | Stop a job |
| DELETE | /jobs/failed/{job_uniqid} | Delete failed job result |
Integration Pools
Grouping of sending accounts (integrations) into pools. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /pools | Fetch list |
| GET | /pools/{pool_id} | Find profile |
| POST | /pools | Create a pool |
| POST | /pools/{pool_id}/{integration_id} | Add an integration in the pool |
| PUT | /pools/{pool_id} | Update profile |
| DELETE | /pools/{pool_id} | Delete a pool |
| DELETE | /pools/{pool_id}/{integration_id} | Remove an integration in the pool |
URL Shortener
Single or bulk creation of short URLs used in messages. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /urls-shortener | Fetch list |
| GET | /urls-shortener/{shortened_url_id} | Find profile |
| GET | /urls-shortener/{url_code} | Find URL by URL code |
| POST | /urls-shortener | Create a shortened URL |
| POST | /urls-shortener/bulk | Create shortened URLs in bulk |
| PUT | /urls-shortener/{shortened_url_id} | Update profile |
| DELETE | /urls-shortener/{shortened_url_id} | Delete a shortened URL |
Forms
Form creation, copying and management. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /forms | Fetch list |
| GET | /forms/{form_id} | Find profile |
| POST | /forms | Create a form |
| POST | /forms/{form_id}/copy | Copy a form |
| PUT | /forms/{form_id} | Update a form profile |
| DELETE | /forms/{form_id} | Delete a form |
Sending channels and deliverability
Connecting sending accounts and deliverability tools (warmup, anti-spam protection, domains). 33 endpoints.
Email Integrations – Email
Gmail, Outlook, SMTP and mass mailing accounts: automatic discovery of server settings, SMTP validity test, warmup settings and statistics, received spam protection. 19 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /integrations/email | Fetch list |
| GET | /integrations/email/{email_account_id} | Find profile |
| GET | /integrations/email/discover/{email} | Discover email server settings using Autodiscover |
| GET | /integrations/email/protections | List the anti spam protections you have received by email |
| GET | /integrations/email/smtp/{email_account_id}/warmup | Retrieve warmup settings for an SMTP email account |
| GET | /integrations/email/smtp/{email_account_id}/warmup/stats | Retrieve warmup statistics for an SMTP email account. |
| POST | /integrations/email/gmail | Add a Gmail email account |
| POST | /integrations/email/mass-mailing | Add an email account for mass mailing |
| POST | /integrations/email/outlook | Add an Outlook email account |
| POST | /integrations/email/smtp | Add an SMTP email account |
| PUT | /integrations/email/gmail/{email_account_id} | Update a Gmail email account |
| PUT | /integrations/email/mass-mailing/{email_account_id} | Update an email account for mass mailing |
| PUT | /integrations/email/mass-mailing/{email_account_id}/force/validate | Force Mass Mailing email validation |
| PUT | /integrations/email/outlook/{email_account_id} | Update an Outlook email account |
| PUT | /integrations/email/protection/{protection_id} | Set a protection as handled |
| PUT | /integrations/email/smtp/{email_account_id} | Update an SMTP email account |
| PUT | /integrations/email/smtp/{email_account_id}/warmup | Update warmup settings for an SMTP email account |
| PUT | /integrations/email/smtp/validity/test | SMTP email accounts validity test |
| DELETE | /integrations/email/{email_account_id} | Delete an email account |
LinkedIn Integrations – LinkedIn
Connecting LinkedIn accounts, resolving authentication checkpoints, updating and deleting. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /integrations/linkedin | Fetch list |
| GET | /integrations/linkedin/{linkedin_account_id} | Find profile |
| POST | /integrations/linkedin | Add a LinkedIn account |
| POST | /integrations/linkedin/{linkedin_account_id}/checkpoint | Solve an authentication checkpoint using a code that you received. If the checkpoint is via the app, you can enter any code you want once validated |
| PUT | /integrations/linkedin/{linkedin_account_id} | Update a LinkedIn account |
| DELETE | /integrations/linkedin/{linkedin_account_id} | Delete a LinkedIn account |
OVH (domains and emails) OVH
Domain availability and pricing check, domain and Email Pro account ordering, OVH asset synchronization. 8 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /ovh | Fetch list |
| GET | /ovh/account/{external_api_key_id}/validate-ordering-prerequisites | Check OVH account readiness for ordering |
| GET | /ovh/domain/availability/{domain}/{external_api_key_id} | Check domain availability and price |
| GET | /ovh/sync-assets/{external_api_key_id}/results | Fetch sync-assets job results |
| POST | /ovh/checkout | Order a domain and/or associated email pro accounts |
| POST | /ovh/sync-assets | Sync OVH domains/emails |
| DELETE | /ovh/domain/{domain_id} | Delete an OVH domain |
| DELETE | /ovh/email/{email_id} | Delete an OVH email account |
PRM: CRM for prospecting
The PRM (Prospect Relationship Management) system centralizes engaged contacts and their history. 57 endpoints.
PRM PRM
Searching for a contact by email or LinkedIn URL, import and export, notes with attachments, calls, sending LinkedIn invitations and messages, custom statuses, tags, sharing between users, nurturing, exclusion from a workflow, enrichment via external API, positive/negative qualification of responses and AI-generated response suggestion. 57 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /prm/contact | Find a contact profile by email or LinkedIn URL |
| GET | /prm/contact/{contact_id} | Find a contact profile |
| GET | /prm/contact/{contact_id}/note/{note_id}/attachments | Get note attachments |
| GET | /prm/contact/user/{user_id} | Find a contact profile of a PRM by email or LinkedIn URL |
| GET | /prm/contacts | Fetch the contacts of your PRM |
| GET | /prm/contacts/shared | Fetch the contacts of your PRM that you shared |
| GET | /prm/contacts/user/{user_id} | Fetch contacts of a PRM |
| GET | /prm/contacts/users | Fetch contacts of multiple PRMs |
| GET | /prm/list | List visible to PRM |
| GET | /prm/notifications/column-entry | Retrieve PRM column-entry notification watchlist |
| GET | /prm/nurturing/{nurturing_id} | Get a PRM nurturing |
| GET | /prm/nurturings | Get PRM nurturings |
| GET | /prm/sharings | Retrieve your PRM sharing |
| GET | /prm/status | Retrieve your PRM statuses |
| GET | /prm/status/custom | Retrieve your PRM custom statuses |
| POST | /prm/contact/{contact_id}/call | Create a PRM call from a contact |
| POST | /prm/contact/{contact_id}/enrich/phone/mobile | Enrich a contact phone number |
| POST | /prm/contact/{contact_id}/exclude/{workflow_id} | Exclude a PRM contact from a workflow |
| POST | /prm/contact/{contact_id}/exclude/programming/{programming_id} | Exclude a PRM contact from a programming |
| POST | /prm/contact/{contact_id}/linkedin/invitation | Send a linkedin invitation to a contact |
| POST | /prm/contact/{contact_id}/linkedin/message | Send a linkedin message to a contact |
| POST | /prm/contact/{contact_id}/note | Create a PRM note from a contact |
| POST | /prm/contact/{contact_id}/note/{note_id}/attachment | Upload note attachments |
| POST | /prm/contact/{contact_id}/programming/{programming_id}/step/{step_id} | Manually progress a contact to an event after a call step |
| POST | /prm/contact/{contact_id}/reply/{history_type_reply}/{reply_id}/suggest-reply | Generate a suggested reply using AI |
| POST | /prm/contacts | Import contact into your PRM |
| POST | /prm/contacts/contact-list/{contact_list_id}/add | Add contacts from a PRM to a contact list |
| POST | /prm/contacts/enrich/external/{enrich_external_api}/{external_api_key_id} | Enrich the prm using an external api |
| POST | /prm/contacts/export/{file_type} | Export the contacts of your PRM |
| POST | /prm/contacts/import | Import contacts |
| POST | /prm/contacts/user/{user_id} | Import contact into a PRM |
| POST | /prm/contacts/user/{user_id}/copy/blacklist/{blacklist_id} | Copy PRM contacts to a blacklist |
| POST | /prm/contacts/user/{user_id}/enrich/external/{enrich_external_api}/{external_api_key_id} | Enrich the prm using an external api |
| POST | /prm/contacts/user/{user_id}/export/{file_type} | Export contacts of a PRM |
| POST | /prm/contacts/user/{user_id}/tags | Add tags to contacts of a PRM |
| POST | /prm/nurturing | Create a PRM nurturing |
| POST | /prm/sharings | Create sharing |
| POST | /prm/status/custom | Create a PRM custom status |
| PUT | /prm/contact/{contact_id} | Update a PRM contact |
| PUT | /prm/contact/{contact_id}/note/{note_id} | Update a PRM note from a contact |
| PUT | /prm/contact/{contact_id}/reply/{history_type_reply}/{reply_id} | Mark a contact reply as positive/negative or remove the mark |
| PUT | /prm/contacts/new_reply | Update PRM contacts new reply |
| PUT | /prm/contacts/status | Update PRM contacts statuses |
| PUT | /prm/notifications/column-entry | Replace PRM column-entry notification watchlist |
| PUT | /prm/nurturing/{nurturing_id} | Update a PRM nurturing |
| PUT | /prm/sharings/{sharing_id} | Update sharing |
| PUT | /prm/status/{status} | Update a PRM status |
| PUT | /prm/status/custom/{status_id} | Update a PRM custom status |
| DELETE | /prm/contact/{contact_id}/call/{call_id} | Delete a PRM call from a contact |
| DELETE | /prm/contact/{contact_id}/note/{note_id} | Delete a PRM note from a contact |
| DELETE | /prm/contact/{contact_id}/note/{note_id}/attachment/{attachment_id} | Delete note attachment |
| DELETE | /prm/contacts | Delete contacts from your PRM |
| DELETE | /prm/contacts/user/{user_id} | Delete contacts from a PRM |
| DELETE | /prm/contacts/user/{user_id}/tags | Remove tags from contacts of a PRM |
| DELETE | /prm/nurturing/{nurturing_id} | Delete a PRM nurturing |
| DELETE | /prm/sharings/{sharing_id} | Delete sharing |
| DELETE | /prm/status/custom/{status_id} | Delete a PRM custom status |
Statistics and reporting
Campaign performance measurement, from the overall level down to the respondent. 26 endpoints.
Statistics
Comprehensive statistics, by integration and by program, detailed daily and exportable. Respondent analysis by channel, country, region, sector, company size, tag, owner, and PRM status. 21 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /statistics/global | Fetch global programming statistics |
| GET | /statistics/integrations | Fetch integrations statistics |
| GET | /statistics/messages | Retrieve the list of possible statistics messages |
| GET | /statistics/programmations | Fetch programming statistics |
| GET | /statistics/programmations/{programmation_id} | Fetch statistics of a programming |
| GET | /statistics/programmations/{programmation_id}/download/{file_type} | Download the statistics of a programming |
| GET | /statistics/programmations/download/{file_type} | Download programming statistics |
| POST | /statistics/date | Fetch programming stats by date |
| POST | /statistics/date/contacts | Download programming contacts by date |
| POST | /statistics/date/detailed | Fetch programming stats by various parameters, day by day |
| POST | /statistics/global/detailed | Fetch global programming stats by various parameters |
| POST | /statistics/responders/by-channel-and-status | Responders by channel and PRM status |
| POST | /statistics/responders/by-company-size | Respondents by company size |
| POST | /statistics/responders/by-company-size-and-status | Responders by company size and PRM status |
| POST | /statistics/responders/by-country | Respondents by country |
| POST | /statistics/responders/by-prm-owner | Responders by PRM contact owner |
| POST | /statistics/responders/by-programming-and-list | Responders by programming and contact list |
| POST | /statistics/responders/by-region | Responders by country and region |
| POST | /statistics/responders/by-sector | Responders by activity sector (top 10) |
| POST | /statistics/responders/by-sector-and-status | Responders by activity sector (top 10) and PRM status |
| POST | /statistics/responders/by-tag | Responders by PRM contact tag |
Reports
Creation and management of custom reports. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /reporting/report/{report_id} | Retrieve a report |
| GET | /reporting/reports | Fetch list of reports |
| POST | /reporting/report | Create a report |
| PUT | /reporting/report/{report_id} | Update report |
| DELETE | /reporting/report/{report_id} | Delete a report |
Automation and third-party integrations
Connecting Magileads to the rest of the stack (CRM, no-code tools, back-office). 22 endpoints.
Webhooks
Creation, testing and management of webhooks to receive Magileads events. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /webhooks | Fetch list |
| GET | /webhooks/{webhook_id} | Find profile |
| POST | /webhooks | Create a webhook |
| POST | /webhooks/{webhook_id}/test | Test a webhook |
| PUT | /webhooks/{webhook_id} | Update a webhook |
| DELETE | /webhooks/{webhook_id} | Delete a webhook |
Zapier Zapier
Zapier Hooks: creation, activation, deactivation, testing and sending. 9 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /zapier | Fetch list |
| GET | /zapier/{zapier_hook_id} | Find profile |
| POST | /zapier | Create a Zapier hook |
| POST | /zapier/{zapier_hook_id}/send | Send a Zapier hook |
| POST | /zapier/{zapier_hook_id}/test | Test a Zapier hook |
| PUT | /zapier/{zapier_hook_id} | Update profile |
| PUT | /zapier/{zapier_hook_id}/activate | Activate a Zapier hook |
| PUT | /zapier/{zapier_hook_id}/deactivate | Deactivate a Zapier hook |
| DELETE | /zapier/{zapier_hook_id} | Delete a Zapier hook |
Crons Crons
Scheduled tasks: creation, manual execution and testing with dummy data. 7 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /crons | Fetch list |
| GET | /crons/{cron_id} | Find profile |
| POST | /crons | Create a cron |
| POST | /crons/{cron_id}/execute | Manually execute a cron |
| POST | /crons/{cron_id}/test | Test a cron with dummy data |
| PUT | /crons/{cron_id} | Update a cron profile |
| DELETE | /crons/{cron_id} | Delete a cron |
White label (resellers)
Endpoints intended for resellers who operate Magileads under their own brand. 33 endpoints.
Resellers
Reseller profile by ID or SaaS domain, users and tags, options, transactional messages, tutorial videos, CNAME and DNS refresh, white-label Chrome extension and OpenRouter key. 22 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /resellers/{reseller_domain_saas} | Find profile by domain SaaS |
| GET | /resellers/{reseller_domain_saas}/users | Fetch users list by domain saas |
| GET | /resellers/{reseller_id} | Find profile by ID |
| GET | /resellers/{reseller_id}/download/extension/chrome | Download extension for Chrome |
| GET | /resellers/{reseller_id}/openrouter-api-key | Retrieve the reseller OpenRouter API key |
| GET | /resellers/{reseller_id}/options | Get options from a reseller |
| GET | /resellers/{reseller_id}/tutorial/videos | Get tutorial videos of a reseller |
| GET | /resellers/{reseller_id}/users | Fetch user list by ID |
| GET | /resellers/cnames | Fetch list of our CNAMES |
| GET | /resellers/messages | Get transactional base messages |
| GET | /resellers/messages/{reseller_id} | Get transactional messages of a reseller, including base messages |
| POST | /resellers | Create a reseller. Users of your reseller will need to use your domain_saas/domain_saas2/domain_saas3/domain_saas4 |
| POST | /resellers/{reseller_id} | Update profile |
| POST | /resellers/{reseller_id}/dns-refresh-requests | DNS refresh requests for reseller domains |
| POST | /resellers/{reseller_id}/messages | Create or update a transactional message for a reseller |
| POST | /resellers/{reseller_id}/options | Create or update multiple options for a reseller |
| POST | /resellers/{reseller_id}/tutorial/videos | Create, update or delete multiple tutorial videos for a reseller |
| PUT | /resellers/{reseller_id}/messages/table-columns/prm-digest | Configure table columns for PRM daily digest email |
| PUT | /resellers/{reseller_id}/role/{user_id} | Update the role of a user |
| PUT | /resellers/{reseller_id}/users/{user_id}/tags | Update reseller user tags |
| DELETE | /resellers/{reseller_id} | Delete a reseller |
| DELETE | /resellers/{reseller_id}/users/{user_id} | Delete reseller user |
Resellers: Mailgun Resellers – Mailgun
Mailgun configuration managed by the reseller: domains (creation, import, sharing, DNS verification) and statistics for the current month. 11 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /resellers/{reseller_id}/mailgun | Retrieve the reseller Mailgun configuration |
| GET | /resellers/{reseller_id}/mailgun/domains | List visible reseller-managed Mailgun domains |
| GET | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Retrieve a reseller-managed Mailgun domain |
| GET | /resellers/{reseller_id}/mailgun/statistics | Retrieve current-month managed Mailgun statistics |
| POST | /resellers/{reseller_id}/mailgun | Configure reseller-managed Mailgun |
| POST | /resellers/{reseller_id}/mailgun/domain-imports | Import an existing Mailgun domain |
| POST | /resellers/{reseller_id}/mailgun/domains | Create a reseller-managed Mailgun domain |
| POST | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Update managed Mailgun domain ownership and sharing |
| POST | /resellers/{reseller_id}/mailgun/domains/{domain_id}/dns-refresh-requests | Refresh managed Mailgun DNS verification |
| DELETE | /resellers/{reseller_id}/mailgun | Delete the reseller Mailgun configuration |
| DELETE | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Delete or detach a managed Mailgun domain |
Files and folders
File storage and folder organization. 11 endpoints.
Files
Upload, search, update and delete files. 6 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /files | Fetch list |
| GET | /files/{file_id} | Find profile |
| POST | /files | Upload a file |
| POST | /files/{file_id} | Update profile |
| POST | /files/search | Search files |
| DELETE | /files/{file_id} | Delete a file |
Folders
Organization of resources into folders. 5 endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /folders | Fetch list |
| GET | /folders/{folder_id} | Find profile |
| POST | /folders | Create a folder |
| PUT | /folders/{folder_id} | Update profile |
| DELETE | /folders/{folder_id} | Delete a folder |
Magileads V2 API FAQ: Magileads V2 API
What is the Magileads API?
The Magileads API is the REST interface of the Magileads B2B multichannel prospecting platform. Described in OpenAPI 3.0 format (version 2.0.0), it exposes 505 endpoints covering LinkedIn and Google Maps targeting, contact enrichment, email, LinkedIn and SMS campaigns, PRM and statistics.
What is the base URL of the Magileads API?
All requests are sent to https://app.api-magileads.net. Responses are in JSON format and all dates are expressed in GMT.
How do I authenticate on the Magileads API?
The simplest method is to pass the API key in the HTTP x-api-key header. The API also offers an OAuth 2.0 server (authorization code flow, token refresh and revocation) for third-party applications.
Can LinkedIn and Sales Navigator leads be extracted via the API?
Yes. The Targeting – LinkedIn group has 27 extraction endpoints: LinkedIn and Sales Navigator searches (people and companies), connections, group members, event attendees, profile visitors, likers, commenters and resharers of posts.
Does the Magileads API incorporate artificial intelligence?
Yes. Endpoints generate email templates (text and HTML), invitations and LinkedIn messages, AI agent briefs, complete workflows per AI agent, and prospect response suggestions in the PRM.
How to connect Magileads to a CRM or a no-code tool?
This can be done via webhooks, Zapier hooks, or by directly querying the PRM and Contact Lists endpoints. Cron jobs allow for the scheduling of recurring tasks.
Is the Magileads V2 API available as a white-label solution?
Yes. The Resellers and Resellers – Mailgun groups allow you to manage a white-label instance: SaaS domain, CNAME, transactional messages, options, users and Mailgun sending domains.
Need help with your integration? Contact Magileads technical support at co*****@*******ds.eu.