> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.heyreach.io/hey-reach-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server. # Overview ## Introduction Welcome to the HeyReach API. Let' get started with a quick setup on how to use the API! ## Finding your API key The first step when using the HeyReach API is authenticating your requests with an API key.\ The API key is used to authenticate the incoming requests and map them to your organization.\ API keys never expire, however they can be deleted/deactivated. ## Authentication After you have your API key, you will need to provide it in every request that you make to the HeyReach API.\ You will need to use add the `X-API-KEY` request header to every request and set you API key as the value. ### Test your API key Once you have your API key, you can check if it's working by sending the following request.\ If everything is working properly, you should get a `200` HTTP status code. #### JavaScript ```javascript curl --location 'https://api.heyreach.io/api/public/auth/CheckApiKey' --header 'X-API-KEY: ' ``` #### Python ```python curl --location 'https://api.heyreach.io/api/public/auth/CheckApiKey' --header 'X-API-KEY: ' ``` #### Java ```java curl --location 'https://api.heyreach.io/api/public/auth/CheckApiKey' --header 'X-API-KEY: ' ``` #### cURL ```curl curl --location 'https://api.heyreach.io/api/public/auth/CheckApiKey' --header 'X-API-KEY: ' ``` #### Shell ```bash curl --location 'https://api.heyreach.io/api/public/auth/CheckApiKey' --header 'X-API-KEY: ' ``` ## Rate Limits HeyReach allows a maximum of `300` requests per minute. All requests are attributed to the same limit.\ Going above the limit will return a `429` HTTP status code and an error. ## Enjoy building 🛠️ ## Docs - [Overview](https://docs.heyreach.io/hey-reach-api/authentication.md) - [Overview](https://docs.heyreach.io/hey-reach-api/linked-in-accounts.md) - [Overview](https://docs.heyreach.io/hey-reach-api/lists.md) - [Overview](https://docs.heyreach.io/hey-reach-api/campaigns.md) - [Overview](https://docs.heyreach.io/hey-reach-api/inbox.md) - [Overview](https://docs.heyreach.io/hey-reach-api/enrichment.md) - [Overview](https://docs.heyreach.io/hey-reach-api/blacklist.md) - [Overview](https://docs.heyreach.io/hey-reach-api/organization.md) - [Overview](https://docs.heyreach.io/hey-reach-api/organization/linked-in-accounts.md) ## API Docs - HeyReach API > Authentication [CheckApiKey](https://docs.heyreach.io/hey-reach-api/authentication/check-api-key.md) - HeyReach API > LinkedInAccounts [GetAll](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/get-all.md) - HeyReach API > LinkedInAccounts [GetById](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/get-by-id.md) - HeyReach API > LinkedInAccounts [RemoveAccount](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/remove-account.md) - HeyReach API > LinkedInAccounts [Connect](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/connect.md) - HeyReach API > LinkedInAccounts [ConnectWithCookies](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/connect-with-cookies.md) - HeyReach API > LinkedInAccounts [GetAccountStatus](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/get-account-status.md) - HeyReach API > LinkedInAccounts [SubmitPin](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/submit-pin.md) - HeyReach API > LinkedInAccounts [Reconnect](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/reconnect.md) - HeyReach API > LinkedInAccounts [ReloginSalesNavigator](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/relogin-sales-navigator.md) - HeyReach API > LinkedInAccounts [ReloginRecruiter](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/relogin-recruiter.md) - HeyReach API > LinkedInAccounts [Resync](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/resync.md) - HeyReach API > LinkedInAccounts [GetProxyCountries](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/get-proxy-countries.md) - HeyReach API > LinkedInAccounts [GetAccountProxy](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/get-account-proxy.md) - HeyReach API > LinkedInAccounts [UpdateProxy](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/update-proxy.md) - HeyReach API > LinkedInAccounts [UpdateInboxConfiguration](https://docs.heyreach.io/hey-reach-api/linked-in-accounts/update-inbox-configuration.md) - HeyReach API > Lists [GetById](https://docs.heyreach.io/hey-reach-api/lists/get-by-id.md) - HeyReach API > Lists [GetAll](https://docs.heyreach.io/hey-reach-api/lists/get-all.md) - HeyReach API > Lists [GetLeadsFromList](https://docs.heyreach.io/hey-reach-api/lists/get-leads-from-list.md) - HeyReach API > Lists [DeleteLeadsFromList](https://docs.heyreach.io/hey-reach-api/lists/delete-leads-from-list.md) - HeyReach API > Lists [DeleteLeadsFromListByProfileUrl](https://docs.heyreach.io/hey-reach-api/lists/delete-leads-from-list-by-profile-url.md) - HeyReach API > Lists [GetCompaniesFromList](https://docs.heyreach.io/hey-reach-api/lists/get-companies-from-list.md) - HeyReach API > Lists [AddLeadsToList](https://docs.heyreach.io/hey-reach-api/lists/add-leads-to-list.md) - HeyReach API > Lists [AddLeadsToListV2](https://docs.heyreach.io/hey-reach-api/lists/add-leads-to-list-v-2.md) - HeyReach API > Lists [GetListsForLead](https://docs.heyreach.io/hey-reach-api/lists/get-lists-for-lead.md) - HeyReach API > Lists [CreateEmptyList](https://docs.heyreach.io/hey-reach-api/lists/create-empty-list.md) - HeyReach API > Lists [UpdateLeadCustomFields](https://docs.heyreach.io/hey-reach-api/lists/update-lead-custom-fields.md) - HeyReach API > Leads [GetLead](https://docs.heyreach.io/hey-reach-api/leads/get-lead.md) - HeyReach API > Leads [AddTags](https://docs.heyreach.io/hey-reach-api/leads/add-tags.md) - HeyReach API > Leads [GetTags](https://docs.heyreach.io/hey-reach-api/leads/get-tags.md) - HeyReach API > Leads [ReplaceTags](https://docs.heyreach.io/hey-reach-api/leads/replace-tags.md) - HeyReach API > LeadTags [CreateTags](https://docs.heyreach.io/hey-reach-api/lead-tags/create-tags.md) - HeyReach API > Campaigns [GetAll](https://docs.heyreach.io/hey-reach-api/campaigns/get-all.md) - HeyReach API > Campaigns [GetById](https://docs.heyreach.io/hey-reach-api/campaigns/get-by-id.md) - HeyReach API > Campaigns [Resume](https://docs.heyreach.io/hey-reach-api/campaigns/resume.md) - HeyReach API > Campaigns [Pause](https://docs.heyreach.io/hey-reach-api/campaigns/pause.md) - HeyReach API > Campaigns [AddLeadsToCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/add-leads-to-campaign.md) - HeyReach API > Campaigns [AddLeadsToCampaignV2](https://docs.heyreach.io/hey-reach-api/campaigns/add-leads-to-campaign-v-2.md) - HeyReach API > Campaigns [StopLeadInCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/stop-lead-in-campaign.md) - HeyReach API > Campaigns [GetLeadsFromCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/get-leads-from-campaign.md) - HeyReach API > Campaigns [GetCampaignsForLead](https://docs.heyreach.io/hey-reach-api/campaigns/get-campaigns-for-lead.md) - HeyReach API > Campaigns [StartCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/start-campaign.md) - HeyReach API > Campaigns [UpdateSettings](https://docs.heyreach.io/hey-reach-api/campaigns/update-settings.md) - HeyReach API > Campaigns [UpdateSchedule](https://docs.heyreach.io/hey-reach-api/campaigns/update-schedule.md) - HeyReach API > Campaigns [UpdateAccounts](https://docs.heyreach.io/hey-reach-api/campaigns/update-accounts.md) - HeyReach API > Campaigns [Create](https://docs.heyreach.io/hey-reach-api/campaigns/create.md) - HeyReach API > Campaigns [UpdateSequence](https://docs.heyreach.io/hey-reach-api/campaigns/update-sequence.md) - HeyReach API > Campaigns [GetCampaignSequence](https://docs.heyreach.io/hey-reach-api/campaigns/get-campaign-sequence.md) - HeyReach API > Campaigns [CreateCampaignFromTemplate](https://docs.heyreach.io/hey-reach-api/campaigns/create-campaign-from-template.md) - HeyReach API > Campaigns [UpdateLeadCustomFields](https://docs.heyreach.io/hey-reach-api/campaigns/update-lead-custom-fields.md) - HeyReach API > Campaigns [AddLinkedInAccountsToCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/add-linked-in-accounts-to-campaign.md) - HeyReach API > Campaigns [RemoveLinkedInAccountsFromCampaign](https://docs.heyreach.io/hey-reach-api/campaigns/remove-linked-in-accounts-from-campaign.md) - HeyReach API > Analytics [Get Overall Stats](https://docs.heyreach.io/hey-reach-api/analytics/get-overall-stats.md) - HeyReach API > Analytics [GetOverallStatsByCampaign](https://docs.heyreach.io/hey-reach-api/analytics/get-overall-stats-by-campaign.md) - HeyReach API > Inbox [GetConversationsV2](https://docs.heyreach.io/hey-reach-api/inbox/get-conversations-v-2.md) - HeyReach API > Inbox [GetConversationsV3](https://docs.heyreach.io/hey-reach-api/inbox/get-conversations-v-3.md) - HeyReach API > Inbox [GetChatroom](https://docs.heyreach.io/hey-reach-api/inbox/get-chatroom.md) - HeyReach API > Inbox [SendMessage](https://docs.heyreach.io/hey-reach-api/inbox/send-message.md) - HeyReach API > Inbox [SetSeenStatus](https://docs.heyreach.io/hey-reach-api/inbox/set-seen-status.md) - HeyReach API > Webhooks [Create Webhook](https://docs.heyreach.io/hey-reach-api/webhooks/create-webhook.md) - HeyReach API > Webhooks [Get Webhook By Id](https://docs.heyreach.io/hey-reach-api/webhooks/get-webhook-by-id.md) - HeyReach API > Webhooks [GetAllWebhooks](https://docs.heyreach.io/hey-reach-api/webhooks/get-all-webhooks.md) - HeyReach API > Webhooks [Update Webhook](https://docs.heyreach.io/hey-reach-api/webhooks/update-webhook.md) - HeyReach API > Webhooks [Delete Webhook](https://docs.heyreach.io/hey-reach-api/webhooks/delete-webhook.md) - HeyReach API > Enrichment [EnrichEmail](https://docs.heyreach.io/hey-reach-api/enrichment/enrich-email.md) - HeyReach API > Enrichment [CheckEnrichEmailJob](https://docs.heyreach.io/hey-reach-api/enrichment/check-enrich-email-job.md) - HeyReach API > Blacklist [GetLeads](https://docs.heyreach.io/hey-reach-api/blacklist/get-leads.md) - HeyReach API > Blacklist [AddLeads](https://docs.heyreach.io/hey-reach-api/blacklist/add-leads.md) - HeyReach API > Blacklist [RemoveLeads](https://docs.heyreach.io/hey-reach-api/blacklist/remove-leads.md) - HeyReach API > Blacklist [GetCompanies](https://docs.heyreach.io/hey-reach-api/blacklist/get-companies.md) - HeyReach API > Blacklist [AddCompanies](https://docs.heyreach.io/hey-reach-api/blacklist/add-companies.md) - HeyReach API > Blacklist [RemoveCompanies](https://docs.heyreach.io/hey-reach-api/blacklist/remove-companies.md) - HeyReach API > MyNetwork [GetMyNetworkForSender](https://docs.heyreach.io/hey-reach-api/my-network/get-my-network-for-sender.md) - HeyReach API > MyNetwork [IsConnection](https://docs.heyreach.io/hey-reach-api/my-network/is-connection.md) - HeyReach API > Organization > Workspace Users [GetAllUsers](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-all-users.md) - HeyReach API > Organization > Workspace Users [InviteAdmins](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/invite-admins.md) - HeyReach API > Organization > Workspace Users [InviteMembers](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/invite-members.md) - HeyReach API > Organization > Workspace Users [InviteManagers](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/invite-managers.md) - HeyReach API > Organization > Workspace Users [GetUserById](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-user-by-id.md) - HeyReach API > Organization > Workspace Users [GetWorkspaceUsers](https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-workspace-users.md) - HeyReach API > Organization > Workspaces [GetAllWorkspaces](https://docs.heyreach.io/hey-reach-api/organization/workspaces/get-all-workspaces.md) - HeyReach API > Organization > Workspaces [CreateWorkspace](https://docs.heyreach.io/hey-reach-api/organization/workspaces/create-workspace.md) - HeyReach API > Organization > Workspaces [UpdateWorkspace](https://docs.heyreach.io/hey-reach-api/organization/workspaces/update-workspace.md) - HeyReach API > Organization > Linked IN Accounts [GetLinkedInAccounts](https://docs.heyreach.io/hey-reach-api/organization/linked-in-accounts/get-linked-in-accounts.md) - HeyReach API > Organization > Linked IN Accounts [DeleteLinkedInAccount](https://docs.heyreach.io/hey-reach-api/organization/linked-in-accounts/delete-linked-in-account.md) - HeyReach API > Organization > Linked IN Accounts [MoveToWorkspace](https://docs.heyreach.io/hey-reach-api/organization/linked-in-accounts/move-to-workspace.md) - HeyReach API > Organization > Workspace API Keys [GetWorkspaceApiKeys](https://docs.heyreach.io/hey-reach-api/organization/workspace-api-keys/get-workspace-api-keys.md) - HeyReach API > Organization > Workspace API Keys [CreateWorkspaceApiKeys](https://docs.heyreach.io/hey-reach-api/organization/workspace-api-keys/create-workspace-api-keys.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.heyreach.io/openapi.json) - [OpenAPI YAML](https://docs.heyreach.io/openapi.yaml)