| POST | /api/v3/workspaces/:workspace_id/seats/lifetime | Assign LTD Seats, This POST request assigns lifetime seats to a specific workspace. NOTE: ⚠️ Warning: This request sets the total number of seats for the workspace, it does not add to the existing count. For example, i | SETS total seats (does not add); master key |
| POST | /api/v3/workspaces/:workspace_id/seats/agency | Assign Agency Seats, This POST request assigns Agency Plan seats to a specific workspace. NOTE: ⚠️ Warning: This request sets the total number of seats for the workspace, it does not add to the existing count. For example | SETS total seats (does not add); master key; billable |
| POST | /api/v3/workspaces | Create Workspace, This POST request creates a new workspace. NOTE: ℹ️ Note: This route requires the Master API key. | Not stated |
| POST | /api/v3/workspaces/:workspace_id/tokens | Create Workspace Token, This POST request creates an API token for a specific workspace. NOTE: ℹ️ Note: This route requires the Master API key. | Not stated |
| GET | /api/v3/workspaces/:workspace_id/tokens | Get Workspace Tokens, This GET request returns all API tokens of a specific workspace. NOTE: ℹ️ Note: This route requires the Master API key. | Not stated |
| GET | /api/v3/workspaces | List Workspaces, This GET request returns all workspaces associated with the provided Master API key. NOTE: ℹ️ Note: This route requires the Master API key. | Not stated |
| POST | /api/v3/clients/token | Generate Client Token, This POST request generates a login token for a client using their email address. The token can be appended to your whitelabel login URL to authenticate the client directly. NOTE: ℹ️ Note: This route | Not stated |
| POST | /api/v3/clients | Create Client, This POST request creates a new client. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/token | Generate Login Token, This POST request generates a login token that can be appended to your whitelabel login URL to authenticate a user directly. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/accounts | List Accounts, This GET request retrieves all LinkedIn accounts in a specific workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/accounts/:account_id/profile | Get Account, This GET request retrieves the details of a specific account. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/accounts/:account_id/limits | Get Account Limits, This GET request retrieves the interaction limits for an account: its Connect and InMail limits (the workspace default unless set for this account) and its warm-up state. NOTE: ℹ️ Note: This route req | Not stated |
| PATCH | /api/v3/accounts/:account_id/limits | Set Account Limits, This PATCH request updates the interaction limits for a specific account. Send only the fields you want to change; the response is the account's limits after the update (as in Get Account Limits). NOT | Not stated |
| GET | /api/v3/accounts/:account_id/file | Get Account File, This GET request fetches a file from the given LinkedIn URL using the specified account and streams it back. NOTE: ⚠️ The url value must be URL-encoded (percent-encoded). LinkedIn file URLs contain th | Not stated |
| POST | /api/v3/analytics/recent-leads | List Recent Leads, This POST request retrieves the workspace's most recent leads: campaign targets that recently became leads (for example by accepting a connection request), with the campaign and the lead's profile. NO | Not stated |
| POST | /api/v3/analytics/interactions | List Interactions, This POST request retrieves all interactions for a specific workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/blacklist:search | Search Blacklisted Profiles, This POST request searches the LinkedIn profiles blacklisted in your workspace and returns one page of results. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 GET /bl | Not stated |
| GET | /api/v3/blacklist-companies | List Blacklisted Companies, This GET request retrieves one page of the LinkedIn companies blacklisted in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: this endpoint is now paginated. | Not stated |
| POST | /api/v3/blacklist-companies | Add Companies To Blacklist, This POST request blacklists multiple LinkedIn companies. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/blacklist/:urn | Add Profile To Blacklist, This POST request adds a LinkedIn profile to your workspace blacklist using their URN, preventing any further interactions or campaign operations from targeting that profile. NOTE: ℹ️ Note: This route | Not stated |
| POST | /api/v3/blacklist | Add Profiles To Blacklist, This POST request adds one or more LinkedIn profiles to your workspace blacklist using their LinkedIn URLs, preventing any further interactions or campaign operations from targeting those profiles. NO | Not stated |
| DELETE | /api/v3/blacklist/:urn | Remove Profile From Blacklist, This DELETE request removes a LinkedIn profile from your workspace blacklist using their URN. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/blacklist-companies/:company_urn | Remove Company From Blacklist, This DELETE request removes a LinkedIn company from your workspace blacklist using their URN. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/campaigns:search | List Campaigns, This POST request retrieves all campaigns in your workspace, including each campaign's details and current status. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 GET | Not stated |
| POST | /api/v3/campaigns | Create Campaign, This POST request creates a new Aimfox campaign in the INIT state. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ Changed with lists: type, audience_size and miner are no longer used and ar | Not stated |
| GET | /api/v3/campaigns/:campaign_id | Get Campaign, This GET request retrieves detailed information about a specific campaign, including its attributes, current status, and associated data. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/campaigns/:campaign_id/targets:search | Search Campaign Targets, This POST request searches the targets of an Aimfox campaign and returns a page of matching targets together with facet counts. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: rep | Not stated |
| DELETE | /api/v3/campaigns/:campaign_id | Delete Campaign, This DELETE request deletes a campaign from your workspace and cancels all of its targets. It can't be undone through the API; the campaign's list is kept. To stop a campaign but keep it, set its stat | Not stated |
| POST | /api/v3/campaigns/:campaign_id/metrics | Get Campaign Metrics, This POST request retrieves the interaction metrics for a specific campaign. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 GET /api/v2/campaigns/:campaign_id/metrics | Not stated |
| POST | /api/v3/campaigns/:campaign_id/targets | Add Targets to Campaign, This POST request adds one or more LinkedIn profiles as targets to an Aimfox campaign, each with its own custom variables. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces | Not stated |
| DELETE | /api/v3/campaigns/:campaign_id/targets/:public_identifier | Remove Target from Campaign, This DELETE request removes a specific target from an Aimfox campaign using their Public Identifier. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| PATCH | /api/v3/campaigns/:campaign_id | Update Campaign, This PATCH request updates a campaign's settings or changes its state. Send only the fields you want to change; the response is the updated campaign (as in Get Campaign). NOTE: ℹ️ Note: This route req | Not stated |
| POST | /api/v3/campaigns/:campaign_id/targets:delete | Delete Campaign Targets, This POST request removes targets from an Aimfox campaign, either by an explicit list of URNs or by filter. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/campaigns/:campaign_id/targets:export | Export Campaign Targets, This POST request exports the targets of an Aimfox campaign, either by an explicit list of URNs or by filter, without pagination. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/campaigns/:campaign_id/cancelled | List Cancelled Campaign Targets, This GET request lists the targets that were cancelled in a campaign and why, oldest first. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/campaigns/:campaign_id/custom-variables | Get Campaign Custom Variables, This GET request retrieves all custom variables associated with a specific campaign. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/campaigns/:campaign_id/custom-variables/:urn | Get Campaign Target Custom Variables, This GET request retrieves all custom variables associated with a specific target within an Aimfox campaign. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/campaigns/:campaign_id/custom-variables | Add Custom Variables to Target, This POST request adds custom variables to a specific target within an Aimfox campaign. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/labels | List Workspace Labels, This GET request retrieves all labels associated with your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/labels | Add Label To Workspace, This POST request adds a new label to your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| PATCH | /api/v3/labels/:label_id | Edit Workspace Label, This PATCH request updates an existing label in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/labels/:label_id | Delete Workspace Label, This DELETE request removes a specific label from your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads/:lead_id | Get Lead Details, This POST request retrieves all data associated with a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 GET /api/v2/leads/:lead_id. account_ids (optional | Not stated |
| GET | /api/v3/accounts/:account_id/leads/:lead_urn/custom-variables | Get Lead Custom Variables, This GET request retrieves all custom variables associated with a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads/:lead_id/labels/:label_id | Add Label To Lead, This POST request adds a label to a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads:search | Search Leads, This POST request searches through all leads in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads:search/facets/:name | Search Lead Facets, This POST request returns the values of one filter, the:name facet, among the leads matching the search, with the number of leads for each value. Use it to build filter options; the body takes the | Not stated |
| POST | /api/v3/leads:search/total | Get Total Leads Count, This POST request retrieves the total count of leads matching the provided filters. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads/:lead_id/labels/:label_id/delete | Remove Label From Lead, This POST request removes a label from a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 DELETE /api/v2/leads/:lead_id/labels/:label_id. account_ids (op | Not stated |
| GET | /api/v3/leads/:lead_id/notes | List Lead Notes, This GET request retrieves all notes associated with a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/leads/:lead_id/notes | Create Lead Note, This POST request adds a note to a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| PATCH | /api/v3/leads/:lead_id/notes/:note_id | Update Lead Note, This PATCH request updates a specific note associated with a lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/leads/:lead_id/notes/:note_id | Delete Lead Note, This DELETE request removes a specific note from a lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/conversations | List Conversations, This POST request retrieves all conversations associated with your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ v3 change: replaces v2 GET /api/v2/conversations. account_ids (o | Not stated |
| GET | /api/v3/accounts/:account_id/conversations/:conversation_urn | Get Conversation, This GET request retrieves the details of a specific conversation using the conversation URN. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/accounts/:account_id/leads/:lead_id/conversation | Get Lead Conversation, This GET request retrieves the conversation URN for a conversation with a specific lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/accounts/:account_id/conversations | Start Conversation, This POST request starts a conversation from the given account with one or more LinkedIn members and sends the first message. NOTE: ⚠️ Disclaimer: Adding multiple recipients does not send individual m | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/send-audio | Start Conversation With Voice Note, This POST request starts a new conversation and sends a voice note as the initial message. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ Note: Voice notes are not supported in Sales Naviga | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/upload-file | Upload File, This POST request uploads a file and returns a file_identifier that can be included in a subsequent message request via file_identifiers[]. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ No | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/:conversation_urn | Send Message To Conversation, This POST request sends a message to an existing conversation. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ Note: Either message or file_identifiers (non-empty) must be provided. | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/:conversation_urn/send-audio | Send Voice Note To Conversation, This POST request sends a voice note to an existing conversation. NOTE: ℹ️ Note: This route requires a normal API key. | ℹ️ Note: Voice notes are not supported in Sales Navigator conversations. | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/:conversation_urn/mark-as-read | Read A Conversation, This POST request marks a specific conversation as read, setting its status to seen. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/accounts/:account_id/conversations/:conversation_urn/messages/:message_id/react | React To Message, This POST request adds a reaction to a specific message in a conversation. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| PATCH | /api/v3/accounts/:account_id/conversations/:conversation_urn/messages/:message_id | Edit Message, This PATCH request edits a specific message in a conversation. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/accounts/:account_id/conversations/:conversation_urn/messages/:message_id | Delete Message, This DELETE request deletes a specific message from a conversation. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/templates | List Templates, This GET request retrieves all templates associated with your workspace, including each template's attributes and usage details. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/templates/:template_id | Get Template, This GET request retrieves the details of a specific template in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/templates | Create Template, This POST request creates a new template in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | 📝 InMail templates include an additional subject field (e.g., "subject": "Hello"). | Not stated |
| PATCH | /api/v3/templates/:template_id | Edit Template, This PATCH request updates a specific template in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/templates/:template_id | Delete Template, This DELETE request removes a specific template from your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/webhooks | List Webhooks, This GET request retrieves all webhooks associated with your workspace, including each webhook's attributes and configuration details. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/webhooks | Create Webhook, This POST request creates a new webhook in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| PATCH | /api/v3/webhooks/:webhook_id | Edit Webhook, This PATCH request updates an existing webhook in your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/webhooks/:webhook_id | Delete Webhook, This DELETE request removes a specific webhook from your workspace. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/lists | Create List, This POST request creates a new, empty list. Add leads to it by creating a source (Create List Source). NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/lists | List Lists, This GET request retrieves all lists in the workspace, with their lead count and the time the last lead was added (last_updated_at). Sources are not included; use Get List for those. NOTE: ℹ️ Note: Th | Not stated |
| GET | /api/v3/lists/:list_id | Get List, This GET request retrieves a single list with its sources, the IDs of the campaigns using it, and the time the last lead was added (last_updated_at). NOTE: ℹ️ Note: This route requires a normal API ke | Not stated |
| PATCH | /api/v3/lists/:list_id | Update List, This PATCH request renames a list. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| DELETE | /api/v3/lists/:list_id | Delete List, This DELETE request deletes a list and cancels any of its sources that are still collecting leads. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/lists/:list_id/leads:search | Search List Leads, This POST request searches the leads in a list and returns a page of matching leads together with facet counts. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| GET | /api/v3/lists/:list_id/custom-variables | Get List Custom Variables, This GET request retrieves the custom variable keys used in a list and the values stored for each lead. NOTE: ℹ️ Note: This route requires a normal API key. | Not stated |
| POST | /api/v3/lists/:list_id/custom-variables | Add Custom Variables to List, This POST request creates or updates custom variables for leads in a list. They can then be used to personalize message templates in campaigns that use the list. NOTE: ℹ️ Note: This route requires a n | Not stated |
| GET | /api/v3/lists/:list_id/source | Get List Sources, This GET request retrieves the sources feeding a list, with their type, state, settings, collection progress (progress, 0–100) and the number of leads each one contributed (total). NOTE: ℹ️ Note: This | Not stated |
| POSTasync | /api/v3/lists/:list_id/source | Create List Source, This POST request adds a source to a list and immediately starts collecting the matching LinkedIn profiles into it. Track progress with Get List Sources. NOTE: ℹ️ Note: This route requires a normal AP | Not stated |