HeyReach
LinkedIn outreach campaigns and inbox.
OutboundAPI key56 endpoints
Runtime credentials
Connecting HeyReach via OAuth or your own API key requires the following secret slots in your workspace:
- HEYREACH_API_KEY
- HEYREACH_ORGANIZATION_API_KEY
Endpoints
| Operation | Method & path | Effect | Latency | Rate | Cost |
|---|---|---|---|---|---|
auth_check_api_key Validate the connected HeyReach public API key. docs ↗ | GET /api/public/auth/CheckApiKey | none | 1-5s | 5/s | no bill |
campaigns_get_all Get a paginated collection of campaigns. docs ↗ | POST /api/public/campaign/GetAll | none | 1-5s | 5/s | no bill |
campaigns_get_by_id Get a campaign by id. docs ↗ | GET /api/public/campaign/GetById | none | 1-5s | 5/s | no bill |
campaigns_create Create a configured HeyReach campaign in draft status. docs ↗ | POST /api/public/campaign/Create | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_update_settings Update campaign name, lead list, and exclusion settings. docs ↗ | POST /api/public/campaign/UpdateSettings | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_update_sequence Replace the sequence tree for a HeyReach campaign. docs ↗ | POST /api/public/campaign/UpdateSequence | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_update_accounts Replace all LinkedIn sender accounts assigned to a campaign. docs ↗ | POST /api/public/campaign/UpdateAccounts | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_update_schedule Replace the schedule for a HeyReach campaign. docs ↗ | POST /api/public/campaign/UpdateSchedule | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_get_sequence Get the current sequence tree for a campaign. docs ↗ | GET /api/public/campaign/GetCampaignSequence | none | 1-5s | 5/s | no bill |
campaigns_resume Resume a campaign. docs ↗ | POST /api/public/campaign/Resume | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_pause Pause a campaign. docs ↗ | POST /api/public/campaign/Pause | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_add_leads Add leads to a campaign. HeyReach accepts up to 100 leads per request. docs ↗ | POST /api/public/campaign/AddLeadsToCampaign | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_add_leads_v2 Add leads to a campaign and return added, updated, and failed counts. docs ↗ | POST /api/public/campaign/AddLeadsToCampaignV2 | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_stop_lead Stop a lead in a campaign. docs ↗ | POST /api/public/campaign/StopLeadInCampaign | campaign_enroll | 1-5s | 5/s | no bill |
campaigns_get_leads Get leads in a campaign. docs ↗ | POST /api/public/campaign/GetLeadsFromCampaign | none | 1-5s | 5/s | no bill |
campaigns_get_for_lead Get campaigns containing a specified lead. docs ↗ | POST /api/public/campaign/GetCampaignsForLead | none | 1-5s | 5/s | no bill |
inbox_get_conversations_v2 Get a paginated collection of LinkedIn conversations. docs ↗ | POST /api/public/inbox/GetConversationsV2 | none | 1-5s | 5/s | no bill |
inbox_get_chatroom Get a LinkedIn conversation and its messages by id. docs ↗ | GET /api/public/inbox/GetChatroom/{accountId}/{conversationId} | none | 1-5s | 5/s | no bill |
inbox_send_message Send a message to a LinkedIn conversation. docs ↗ | POST /api/public/inbox/SendMessage | external_send | 1-5s | 5/s | no bill |
inbox_set_seen_status Mark a conversation seen or unseen. docs ↗ | POST /api/public/inbox/SetSeenStatus | external_send | 1-5s | 5/s | no bill |
linkedin_accounts_get_all List HeyReach sender accounts for campaign account selection. docs ↗ | POST /api/public/li_account/GetAll | none | 1-5s | 5/s | no bill |
linkedin_accounts_get_by_id Get a LinkedIn sender account by id. docs ↗ | GET /api/public/li_account/GetById | none | 1-5s | 5/s | no bill |
lists_get_by_id Get a lead or company list by id. docs ↗ | GET /api/public/list/GetById | none | 1-5s | 5/s | no bill |
lists_get_all Find HeyReach lead lists and company lists. docs ↗ | POST /api/public/list/GetAll | none | 1-5s | 5/s | no bill |
lists_get_leads Get leads from a lead list. docs ↗ | POST /api/public/list/GetLeadsFromList | none | 1-5s | 5/s | no bill |
lists_delete_leads Delete specified leads from a lead list by member id. docs ↗ | DELETE /api/public/list/DeleteLeadsFromList | campaign_enroll | 1-5s | 5/s | no bill |
lists_delete_leads_by_profile_url Delete specified leads from a lead list by LinkedIn profile URL. docs ↗ | DELETE /api/public/list/DeleteLeadsFromListByProfileUrl | campaign_enroll | 1-5s | 5/s | no bill |
lists_get_companies Get companies from a company list. docs ↗ | POST /api/public/list/GetCompaniesFromList | none | 1-5s | 5/s | no bill |
lists_add_leads Add leads to a lead list. HeyReach accepts up to 100 leads per request. docs ↗ | POST /api/public/list/AddLeadsToList | campaign_enroll | 1-5s | 5/s | no bill |
lists_add_leads_v2 Add leads to a lead list and return added, updated, and failed counts. docs ↗ | POST /api/public/list/AddLeadsToListV2 | campaign_enroll | 1-5s | 5/s | no bill |
lists_get_for_lead Get lists containing a specified lead. docs ↗ | POST /api/public/list/GetListsForLead | none | 1-5s | 5/s | no bill |
lists_create_empty Create an empty lead or company list. docs ↗ | POST /api/public/list/CreateEmptyList | campaign_enroll | 1-5s | 5/s | no bill |
stats_get_overall Get HeyReach campaign stats for accounts, campaigns, and date range filters. docs ↗ | POST /api/public/stats/GetOverallStats | none | 1-5s | 5/s | no bill |
leads_get Get lead details by LinkedIn profile URL. docs ↗ | POST /api/public/lead/GetLead | none | 1-5s | 5/s | no bill |
leads_add_tags Add tags to a lead. docs ↗ | POST /api/public/lead/AddTags | campaign_enroll | 1-5s | 5/s | no bill |
leads_get_tags Get tags for a lead. docs ↗ | POST /api/public/lead/GetTags | none | 1-5s | 5/s | no bill |
leads_replace_tags Replace all tags on a lead. docs ↗ | POST /api/public/lead/ReplaceTags | campaign_enroll | 1-5s | 5/s | no bill |
lead_tags_create Create one or multiple tags in the workspace. docs ↗ | POST /api/public/lead_tags/CreateTags | campaign_enroll | 1-5s | 5/s | no bill |
webhooks_create Create a HeyReach webhook configuration. docs ↗ | POST /api/public/webhooks/CreateWebhook | external_send | 1-5s | 5/s | no bill |
webhooks_get_by_id Get a webhook by id. docs ↗ | GET /api/public/webhooks/GetWebhookById | none | 1-5s | 5/s | no bill |
webhooks_get_all Get all webhooks. docs ↗ | POST /api/public/webhooks/GetAllWebhooks | none | 1-5s | 5/s | no bill |
webhooks_update Update a HeyReach webhook configuration. docs ↗ | PATCH /api/public/webhooks/UpdateWebhook | external_send | 1-5s | 5/s | no bill |
webhooks_delete Delete a HeyReach webhook. docs ↗ | DELETE /api/public/webhooks/DeleteWebhook | external_send | 1-5s | 5/s | no bill |
my_network_get_for_sender Get a paginated list of a sender's LinkedIn network. docs ↗ | POST /api/public/MyNetwork/GetMyNetworkForSender | none | 1-5s | 5/s | no bill |
my_network_is_connection Check whether a lead is connected to a sender. docs ↗ | POST /api/public/MyNetwork/IsConnection | none | 1-5s | 5/s | no bill |
organization_workspace_api_keys_get Get public API, workflow automation, MCP, and related integration keys for a workspace. docs ↗ | GET /api/public/management/organizations/api-keys/workspaces/{workspaceId} | none | 1-5s | 5/s | no bill |
organization_workspace_api_keys_create Generate new API or integration keys in a workspace. docs ↗ | POST /api/public/management/organizations/api-keys/workspaces/{workspaceId} | crm_write | 1-5s | 5/s | no bill |
organization_workspaces_get_all List all workspaces in the HeyReach organization. docs ↗ | GET /api/public/management/organizations/workspaces | none | 1-5s | 5/s | no bill |
organization_workspaces_create Create a workspace in the HeyReach organization. docs ↗ | POST /api/public/management/organizations/workspaces | crm_write | 1-5s | 5/s | no bill |
organization_workspaces_update Update a workspace in the HeyReach organization. docs ↗ | PATCH /api/public/management/organizations/workspaces/{workspaceId} | crm_write | 1-5s | 5/s | no bill |
organization_users_get_all List users in the HeyReach organization. docs ↗ | POST /api/public/management/organizations/users | none | 1-5s | 5/s | no bill |
organization_users_invite_admins Invite organization admins. docs ↗ | POST /api/public/management/organizations/users/invite/admins | crm_write | 1-5s | 5/s | no bill |
organization_users_invite_members Invite workspace members with permissions. docs ↗ | POST /api/public/management/organizations/users/invite/members | crm_write | 1-5s | 5/s | no bill |
organization_users_invite_managers Invite workspace managers. docs ↗ | POST /api/public/management/organizations/users/invite/managers | crm_write | 1-5s | 5/s | no bill |
organization_users_get_by_id Get information about an organization user. docs ↗ | GET /api/public/management/organizations/users/{userId} | none | 1-5s | 5/s | no bill |
organization_workspace_users_get Get users in a workspace with their roles and permissions. docs ↗ | POST /api/public/management/organizations/users/workspaces/{workspaceId} | none | 1-5s | 5/s | no bill |