{"info":{"_postman_id":"fabb4f9d-2afd-46d8-9fce-23113ec8d7c5","name":"HeyReach API","description":"

Introduction

\n

Welcome to the HeyReach API. Let' get started with a quick setup on how to use the API!

\n

Finding your API key

\n

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.

\n

Authentication

\n

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.

\n

Test your API key

\n

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.

\n
curl --location &#x27;https://api.heyreach.io/api/public/auth/CheckApiKey&#x27; --header &#x27;X-API-KEY: <YOUR_API_KEY>&#x27;\n\n

Rate Limits

\n

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.

\n

Enjoy building 🛠️

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23808049","collectionId":"fabb4f9d-2afd-46d8-9fce-23113ec8d7c5","publishedId":"2sA2xb5F75","public":true,"customColor":{"top-bar":"100f26","right-sidebar":"303030","highlight":"1c64f2"},"publishDate":"2024-03-01T11:29:43.000Z"},"item":[{"name":"PublicAuthentication","item":[{"name":"CheckApiKey","id":"96209d68-9333-4e86-a674-774eb7c4c5ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/auth/CheckApiKey","description":"

Check If your API key is working.

\n","urlObject":{"path":["api","public","auth","CheckApiKey"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"dbd037df-05e6-4aca-857b-8eff2a4b2343","name":"Success","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""}],"url":"https://api.heyreach.io/api/public/auth/CheckApiKey"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"029781ea-4c16-47d0-b075-90136f98000c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/auth/CheckApiKey"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"f0b48c92-cbdb-4337-bea7-856adf2be13d","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/auth/CheckApiKey"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"96209d68-9333-4e86-a674-774eb7c4c5ee"}],"id":"ac5dd276-52d6-4cf2-a0ce-bd21d8766a7c","description":"

Check if your API token is set up properly

\n","_postman_id":"ac5dd276-52d6-4cf2-a0ce-bd21d8766a7c"},{"name":"PublicCampaigns","item":[{"name":"GetAll","id":"4aaf461e-54c4-4447-beb6-eb5ccca53fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"keyword\": \"my campaign name\",\n \"statuses\": [\"DRAFT\", \"IN_PROGRESS\", \"PAUSED\", \"FINISHED\", \"CANCELED\", \"FAILED\", \"STARTING\", \"SCHEDULED\"],\n \"accountIds\": [123, 2, 5],\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetAll","description":"

Get a paginated collection of all campaigns. Get up to 100 campaigns per request.

\n","urlObject":{"path":["api","public","campaign","GetAll"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"f4133a3b-8036-47a6-9f97-07efdad4e1d9","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetAll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n }\n ]\n}"},{"id":"d85e8d5f-504b-4165-b490-aa1dc6289200","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetAll"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"43e605ad-a7d7-4da1-8054-d9ccd066fdcd","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetAll"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"144fbbde-8f35-4a88-9889-24991b1218ba","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetAll"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"4aaf461e-54c4-4447-beb6-eb5ccca53fb3"},{"name":"GetById","id":"ecf9b5c6-3bee-4437-83c7-0a4b4b269aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/campaign/GetById?campaignId=","description":"

Get a Campaign by id

\n","urlObject":{"path":["api","public","campaign","GetById"],"host":["https://api.heyreach.io"],"query":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"6e38182b-a3d6-45e4-b71b-cba49171c747","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/GetById?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","GetById"],"query":[{"key":"campaignId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 274079,\n \"name\": \"My First Campaign\",\n \"creationTime\": \"2025-12-01T08:06:15.463169Z\",\n \"linkedInUserListName\": \"LinkedIn Ad BF Leads\",\n \"linkedInUserListId\": 123456,\n \"campaignAccountIds\": [\n 113298\n ],\n \"status\": \"IN_PROGRESS\",\n \"progressStats\": {\n \"totalUsers\": 9,\n \"totalUsersInProgress\": 8,\n \"totalUsersPending\": 0,\n \"totalUsersFinished\": 1,\n \"totalUsersFailed\": 0,\n \"totalUsersManuallyStopped\": 0,\n \"totalUsersExcluded\": 0\n },\n \"excludeInOtherCampaigns\": false,\n \"excludeHasOtherAccConversations\": false,\n \"excludeContactedFromSenderInOtherCampaign\": false,\n \"excludeListId\": null,\n \"organizationUnitId\": 12345\n}"},{"id":"f921d3a1-e721-4ee9-828e-4c13259f8562","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/GetById?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"feac8b66-d7c4-4f68-9735-8ddbf4585e4b","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/GetById?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"ff886d80-be5a-425e-9f2e-afc0ab7a4f05","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/GetById?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"ecf9b5c6-3bee-4437-83c7-0a4b4b269aae"},{"name":"Resume","id":"af1c918e-e1e3-41c1-92bd-c6727dd80227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/campaign/Resume?campaignId=","description":"

Resumes the specified campaign.

\n","urlObject":{"path":["api","public","campaign","Resume"],"host":["https://api.heyreach.io"],"query":[{"description":{"content":"

(Required) The id of the campaign to be resumed

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[],"_postman_id":"af1c918e-e1e3-41c1-92bd-c6727dd80227"},{"name":"Pause","id":"9e750677-0d67-4511-a97a-b3740139744c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","description":"

Pauses the specified campaign.

\n","urlObject":{"path":["api","public","campaign","Pause"],"host":["https://api.heyreach.io"],"query":[{"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"15582de4-5af8-4327-a025-5d473359d1c7","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n }\n ]\n}"},{"id":"53778958-4cbf-4298-9d8d-f4eadd887fb4","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"678dca57-348f-4cbf-bb2f-2dfe9e26fd06","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"984c214b-afd5-4d8f-aec8-2882b3db7b08","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"ebe6b907-64d1-47c7-8e98-e2c012dc5523","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/campaign/Pause?campaignId=","host":["https://api.heyreach.io"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"9e750677-0d67-4511-a97a-b3740139744c"},{"name":"AddLeadsToCampaign","id":"b0d7923a-2193-40fb-80be-6300a0ebafc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"salama","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign","description":"

Add leads to a campaign. Add up to 100 leads per request. If a LinkedIn account Idis specified in the AccountLeadPairs, that lead will be mapped to the accountin the campaign.

\n

The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores _. An error will be return in the case the name field does not follow this format.

\n","urlObject":{"path":["api","public","campaign","AddLeadsToCampaign"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"fea98502-b046-4d21-a41e-5bfd49ee44b7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\",\n \"resumeFinishedCampaign\": \"\",\n \"resumePausedCampaign\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"0"},{"id":"c915fe08-e7f8-4425-8def-93b30220c9a2","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"1c5d62e2-88c0-475c-8028-ddaa47f1457a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"d9fd54b8-5bb7-45b6-b81e-f319144019a7","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"5dc7227c-94e3-494b-93eb-3a3c71db0326","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaign"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"b0d7923a-2193-40fb-80be-6300a0ebafc3"},{"name":"AddLeadsToCampaignV2","id":"9071e40e-3f6f-473c-b107-b07d36c25d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"salama","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2","description":"

Add leads to a campaign. Add up to 100 leads per request. If a LinkedIn account Idis specified in the AccountLeadPairs, that lead will be mapped to the accountin the campaign. Same as the AddLeadsToCampaign request, however this request returns counts for how many of the leads were added, how many were update and how many failed to be added.

\n

The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores _. An error will be return in the case the name field does not follow this format.

\n","urlObject":{"path":["api","public","campaign","AddLeadsToCampaignV2"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"df58f4e3-3a58-4f67-a1d9-8d4be053d8a1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\",\n \"resumeFinishedCampaign\": \"\",\n \"resumePausedCampaign\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"addedLeadsCount\": 10,\n \"updatedLeadsCount\": 1,\n \"failedLeadsCount\": 0\n}"},{"id":"cda13e05-aaff-4705-b090-703a9c483d12","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"adb73bb6-af3f-4dc5-9c8f-6def29326bf5","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"9fcb797f-9763-40fb-9031-29f41a25cb5a","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"1cde296b-005d-4b17-ac0a-453ac1a87b48","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/AddLeadsToCampaignV2"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"9071e40e-3f6f-473c-b107-b07d36c25d29"},{"name":"StopLeadInCampaign","id":"c744e1f5-df47-48b2-af7f-f2916205124e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 123,\r\n \"leadMemberId\": \"123123123\",\r\n \"leadUrl\": \"https://www.linkedin.com/in/john-doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/StopLeadInCampaign","description":"

Stops a lead in a campaign

\n

Call this method if you want to stop the progression of a lead in a campaign.

\n

Body Parameters

\n
    \n

  • campaignId (integer): The ID of the campaign.

    \n
    • \n

  • leadMemberId: The lead member Id. You can get the member Id from the field 'linkedin_id' in the method 'GetLeadsFromCampaign' or from 'GetLeadsFromList'

    \n
    • \n

  • leadUrl: the linked in URL for the lead

    \n
    • \n
\n","urlObject":{"path":["api","public","campaign","StopLeadInCampaign"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"e47b79f8-0a79-4282-bcde-878f98dc7685","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 123,\r\n \"leadMemberId\": null,\r\n \"leadUrl\": \"https://www.linkedin.com/in/john-doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/StopLeadInCampaign"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c744e1f5-df47-48b2-af7f-f2916205124e"},{"name":"GetLeadsFromCampaign","id":"eec5fce8-0466-4a55-8b37-2badb1e7210c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 1805\r\n ,\"offset\": 0\r\n ,\"limit\": 100\r\n ,\"timeFrom\": \"2024-10-06T17:34:00+02:00\"\r\n ,\"timeTo\": \"2024-10-07T17:36:00+02:00\"\r\n ,\"timeFilter\": \"CreationTime\"\r\n //,\"timeFilter\": \"Everywhere\" \r\n //,\"timeFilter\": \"LastActionTakenTime\" \r\n //,\"timeFilter\": \"FailedTime\" \r\n //,\"timeFilter\": \"LastActionTakenOrFailedTime\" \r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetLeadsFromCampaign","description":"

Gets the leads that are in a campaign.

\n

This request corresponds to the \"Lead Analytics\" screen in the UI.
Remark: It shows only the \"Pending\" leads that are about to start executing actions in the campaign. There might be more \"Pending\" leads from the specified lead list, that the system will insert later for execution.

\n

Body Parameters

\n
    \n

  • campaignId (integer): The ID of the campaign.

    \n
    • \n

  • offset (integer): The number of records to skip (for pagination).

    \n
    • \n

  • limit (integer): The maximum number of records to return.

    \n
    • \n

  • timeFrom (string, ISO 8601): The start of the time range for filtering.

    \n
    • \n

  • timeTo (string, ISO 8601): The end of the time range for filtering.

    \n
    • \n

  • timeFilter (string): Defines the time filter for fetching leads. Possible values:

    \n
      \n

    • CreationTime: Filters leads by their creation time.

      \n
      • \n

    • Everywhere: No specific time filtering is applied. (Default behavior if omitted)

      \n
      • \n

    • LastActionTakenTime: Filters leads that executed an action within the given time range

      \n
      • \n

    • FailedTime: Filters leads that executed an action within the given time range

      \n
      • \n

    • LastActionTakenOrFailedTime: Filters leads that executed an action OR failed within the given time range

      \n
      • \n
    \n
    • \n
\n

Response:

\n
LeadCampaignStatus
\n
    \n

  • Pending

    \n
    • \n

  • InSequence

    \n
    • \n

  • Finished

    \n
    • \n

  • Paused

    \n
    • \n

  • Failed

    \n
    • \n
\n
LeadConnectionStatus
\n
    \n

  • None

    \n
    • \n

  • ConnectionSent

    \n
    • \n

  • ConnectionAccepted

    \n
    • \n
\n
LeadMessageStatus
\n
    \n

  • None

    \n
    • \n

  • MessageSent

    \n
    • \n

  • MessageReply

    \n
    • \n
\n
LeadStatusMessage (string)
\n

Usually null, but if the lead is in Failed status, this shows the reason why the lead failed.

\n","urlObject":{"path":["api","public","campaign","GetLeadsFromCampaign"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"cf294fa9-2b52-4116-95ac-bbc087f43271","name":"GetLeadsFromCampaign","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 1805\r\n ,\"offset\": 0\r\n ,\"limit\": 100\r\n ,\"timeFrom\": \"2024-10-06T17:34:00+02:00\"\r\n ,\"timeTo\": \"2024-10-07T17:36:00+02:00\"\r\n ,\"timeFilter\": \"CreationTime\"\r\n //,\"timeFilter\": \"Everywhere\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetLeadsFromCampaign"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 152,\r\n \"items\": [\r\n {\r\n \"id\": 62658,\r\n \"linkedInUserProfileId\": \"AC9sANasasasX0Ia-q6DQxyS35UD7a8716G5c8\",\r\n \"linkedInUserProfile\": {\r\n \"linkedin_id\": \"58344979\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/johndoe\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"headline\": \"Communications and Marketing Professional\",\r\n \"imageUrl\": \"https://media.licdn.com/dms/image/v2/D4E03AQH0WJHn5rNRpA/profile-displayphoto-shrink_100_100/profile-displayphoto-shrink_100_100/0/1671ss497?e=173ss&\",\r\n \"location\": \"Princetown\",\r\n \"companyName\": \"ACME\",\r\n \"companyUrl\": null,\r\n \"position\": \"\",\r\n \"about\": null,\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"emailAddress\": null\r\n },\r\n \"lastActionTime\": \"2024-10-01T03:28:22.414791Z\",\r\n \"failedTime\": null,\r\n \"creationTime\": \"2024-09-30T21:28:06.933349Z\",\r\n \"leadCampaignStatus\": \"Finished\",\r\n \"leadConnectionStatus\": \"None\",\r\n \"leadMessageStatus\": \"None\",\r\n \"errorCode\": null,\r\n \"leadCampaignStatusMessage\": null,\r\n \"linkedInSenderId\": 1108,\r\n \"linkedInSenderFullName\": \"Jane Doe\"\r\n } \r\n ]\r\n}"}],"_postman_id":"eec5fce8-0466-4a55-8b37-2badb1e7210c"},{"name":"GetCampaignsForLead","id":"380f09d2-5c98-4f09-ba18-2909d1e6c026","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"string\",\r\n \"linkedinId\": \"string\",\r\n \"profileUrl\": \"string\",\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetCampaignsForLead","description":"

Gets Campaigns for a Lead

\n

Retrieves the list of campaigns where the specified lead is.

\n

Remark: The response will contain campaigns that match the provided lead information, such as email, LinkedIn ID, or profile URL.

\n

Body Parameters

\n
    \n

  • email (string, optional): The email address of the lead.

    \n
    • \n

  • linkedinId (string, optional): The LinkedIn ID of the lead.

    \n
    • \n

  • profileUrl (string, optional): The LinkedIn profile URL of the lead.

    \n
    • \n

  • for example: https://www.linkedin.com/in/john_doe/

    \n
    • \n

  • offset (integer): The number of records to skip (for pagination).

    \n
    • \n

  • limit (integer): The maximum number of records to return.

    \n
    • \n
\n

Response:

\n
LeadStatus
\n
    \n

  • Pending

    \n
    • \n

  • InSequence

    \n
    • \n

  • Finished

    \n
    • \n

  • Paused

    \n
    • \n

  • Failed

    \n
    • \n

  • Excluded

    \n
    • \n

  • PendingOrExcludedToBeCalculated

    \n
    • \n
\n
CampaignStatus
\n
    \n

  • DRAFT

    \n
    • \n

  • IN_PROGRESS

    \n
    • \n

  • PAUSED

    \n
    • \n

  • FINISHED

    \n
    • \n

  • CANCELED

    \n
    • \n

  • FAILED

    \n
    • \n

  • STARTING

    \n
    • \n
\n","urlObject":{"path":["api","public","campaign","GetCampaignsForLead"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"2466d366-1c73-4f11-9fc1-a7cc37d19082","name":"GeCampaignsForLead","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john_doe@example.com\",\r\n \"linkedinId\": \"1254asd3\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe\",\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/campaign/GetCampaignsForLead"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"leadFullName\": \"John Doe\",\r\n \"totalCount\": 2,\r\n \"items\": [\r\n {\r\n \"campaignId\": 1082,\r\n \"campaignName\": \"Campaign For Veterans\",\r\n \"campaignStatus\": \"PAUSED\",\r\n \"creationTime\": \"2025-11-12T13:22:29.96342Z\",\r\n \"leadStatus\": \"Finished\"\r\n },\r\n {\r\n \"campaignId\": 1451,\r\n \"campaignName\": \"Campaign 5\",\r\n \"campaignStatus\": \"CANCELED\",\r\n \"creationTime\": \"2025-10-12T13:22:29.96342Z\",\r\n \"leadStatus\": \"Finished\"\r\n }\r\n ]\r\n}"}],"_postman_id":"380f09d2-5c98-4f09-ba18-2909d1e6c026"}],"id":"cfef6f03-7c75-40ec-9d0e-dec65ebd3830","description":"

Methods for working with HeyReach campaigns. Filter, pause resume and manage leads inside your campaigns.

\n","_postman_id":"cfef6f03-7c75-40ec-9d0e-dec65ebd3830"},{"name":"PublicInbox","item":[{"name":"GetConversationsV2","id":"c76026be-43e7-44ba-8776-1748007fa22d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"filters\": {\n \"linkedInAccountIds\": [],\n \"campaignIds\": [],\n \"searchString\": \"\",\n \"leadLinkedInId\": \"\",\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"tags\": [\n \"Lead tag1\",\n \"Lead Tag2\"\n ],\n \"seen\": null\n },\n \"offset\": 0,\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/GetConversationsV2","description":"

Get a paginated collection of LinkedIn conversations. Get up to 100 lists per request.

\n

Body Parameters

\n
    \n

  • filters

    \n
      \n

    • linkedInAccountIds (int[]): The ids of the LinkedIn senders

      \n
      • \n

    • campaignIds (int[])

      \n
      • \n

    • searchString (string, optional)

      \n
      • \n

    • leadLinkedInId (string, optional) - The LinkedIn ID of the lead. You can find this ID as \"linkedin_id\" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.

      \n
      • \n

    • leadProfileUrl (string, optional) - The linkedin URL of the lead

      \n
      • \n

    • searchString (string, optional)

      \n
      • \n

    • tags - case-insensitive list of lead's tags. Only the conversations of the leads that have at least one of the tags will be exported.

      \n
      • \n

    • seen (boolean. optional)

      \n
      • \n
    \n
    • \n
\n","urlObject":{"path":["api","public","inbox","GetConversationsV2"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"82c6828b-9b76-4468-83ad-66027e76ff96","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"filters\": {\n \"linkedInAccountIds\": [ \n ],\n \"campaignIds\": [ \n ],\n \"searchString\": \"string\",\n \"leadLinkedInId\": \"string\",\n \"leadProfileUrl\": \"string\",\n \"tags\": [\n \"Lead tag1\",\n \"Lead Tag2\"\n ],\n \"seen\": null | true | false\n },\n \"offset\": 0,\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/GetConversationsV2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"string\",\r\n \"read\": true,\r\n \"groupChat\": true,\r\n \"blockedByMe\": true,\r\n \"blockedByParticipant\": true,\r\n \"lastMessageAt\": \"2025-03-28T12:00:19.007Z\",\r\n \"lastMessageText\": \"string\",\r\n \"lastMessageType\": \"TEXT\",\r\n \"lastMessageSender\": \"ME\",\r\n \"totalMessages\": 0, \r\n \"linkedInAccountId\": 0,\r\n \"correspondentProfile\": {\r\n \"id\": \"string\",\r\n \"linkedin_id\": \"string\",\r\n \"profileUrl\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"headline\": \"string\",\r\n \"imageUrl\": \"string\",\r\n \"location\": \"string\",\r\n \"companyName\": \"string\",\r\n \"companyUrl\": \"string\",\r\n \"position\": \"string\",\r\n \"about\": \"string\",\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"tags\": [\r\n \"string\"\r\n ],\r\n \"emailAddress\": \"string\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"linkedInAccount\": {\r\n \"id\": 0,\r\n \"emailAddress\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"isActive\": true,\r\n \"activeCampaigns\": 0,\r\n \"authIsValid\": true,\r\n \"isValidNavigator\": true,\r\n \"isValidRecruiter\": true\r\n },\r\n \"messages\": [\r\n {\r\n \"createdAt\": \"2025-03-28T12:00:19.007Z\",\r\n \"body\": \"string\",\r\n \"subject\": \"string\",\r\n \"postLink\": \"string\",\r\n \"isInMail\": true,\r\n \"sender\": \"ME\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"c76026be-43e7-44ba-8776-1748007fa22d"},{"name":"GetChatroom","id":"4476f6de-4085-4418-98fb-61661149696a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","description":"

Get a LinkedIn conversation with its messages by Id.

\n","urlObject":{"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"id":"6bab4375-cd03-4f80-b973-953ac9e5fc94","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"accountId"},{"id":"09b4f17d-1f62-400b-85a1-77e40e31260c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"conversationId"}]}},"response":[{"id":"f5323f5e-f216-4bc8-8241-50238480f9a6","name":"Success","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","host":["https://api.heyreach.io"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId"},{"key":"conversationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"read\": \"\",\n \"groupChat\": \"\",\n \"blockedByMe\": \"\",\n \"blockedByParticipant\": \"\",\n \"lastMessageAt\": \"\",\n \"lastMessageText\": \"\",\n \"lastMessageSender\": null,\n \"totalMessages\": \"\",\n \"campaignId\": \"\",\n \"linkedInAccountId\": \"\",\n \"correspondentProfile\": {\n \"profileUrl\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"headline\": \"\",\n \"imageUrl\": \"\",\n \"location\": \"\",\n \"companyName\": \"\",\n \"companyUrl\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"connections\": \"\",\n \"followers\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"emailAddress\": \"\",\n \"customFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccount\": {\n \"id\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"isActive\": \"\",\n \"activeCampaigns\": \"\",\n \"authIsValid\": \"\",\n \"isValidNavigator\": \"\",\n \"isValidRecruiter\": \"\"\n },\n \"messages\": [\n {\n \"createdAt\": \"\",\n \"body\": \"\",\n \"subject\": \"\",\n \"postLink\": \"\",\n \"isInMail\": \"\",\n \"sender\": null\n },\n {\n \"createdAt\": \"\",\n \"body\": \"\",\n \"subject\": \"\",\n \"postLink\": \"\",\n \"isInMail\": \"\",\n \"sender\": null\n }\n ]\n}"},{"id":"e6335fb5-cb37-4c76-917c-aee33325ad96","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","host":["https://api.heyreach.io"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId"},{"key":"conversationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"52c5f28f-50fb-4d67-9ed6-227da84f253d","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","host":["https://api.heyreach.io"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId"},{"key":"conversationId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"7eeb13e5-1397-4e0f-a039-41c80cd499f3","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","host":["https://api.heyreach.io"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId"},{"key":"conversationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"b7f0b9e2-fba3-4772-9bf4-dde4afc7596a","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/inbox/GetChatroom/:accountId/:conversationId","host":["https://api.heyreach.io"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId"},{"key":"conversationId"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"4476f6de-4085-4418-98fb-61661149696a"},{"name":"SendMessage","id":"6e32c3b6-bffc-4ea7-8a51-0e6416dad1df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"Hi there\",\n \"subject\": \"Hi there\",\n \"conversationId\": \"2-ODM0YmIzNzgtOGEyOS00ZTYzLWExYTItNmM0MWNhMjNlNGZjXzAxMw==\",\n \"linkedInAccountId\": 123\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage","description":"

Send a message to a LinkedIn conversation.

\n

Parameters:

\n
    \n
  • linkedInAccountId - The id of your LinkedIn sender
    • \n
\n","urlObject":{"path":["api","public","inbox","SendMessage"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"8afa0b27-bbe8-49dc-9611-4545ef8d9bd8","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"dfdd223c-ca01-4cc6-b1c1-590da5171034","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"4674ff15-1bb4-4a16-9f86-46619a17e51a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"edaf9ef3-103f-4a0d-8654-5ac17425de32","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"0363b980-f7a6-45d7-8333-129116031ec6","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"5aca8d43-9832-42cc-8d2e-1f2bd411b583","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n \"subject\": \"\",\n \"conversationId\": \"\",\n \"linkedInAccountId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SendMessage"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"6e32c3b6-bffc-4ea7-8a51-0e6416dad1df"},{"name":"SetSeenStatus","id":"108e2be9-9eb3-497a-8122-9773c4d1b3f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Public API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus","description":"

Mark a given conversation as seen or unseen based on the seen parameter.

\n","urlObject":{"path":["api","public","inbox","SetSeenStatus"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"b05e98af-7acd-442c-ad91-1eaff363d3e3","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"879dfe6a-5ffb-4f63-93d0-ec8f7ed6d350","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"string\"\n}"},{"id":"3cb2c77c-5a08-4458-a979-705c2421f741","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 6209,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"ad635a00-2131-4da3-8819-dc64fbfd104e","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"string\"\n}"},{"id":"a8c06f14-33af-43c0-bd44-1732837c66db","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"string\"\n}"},{"id":"519b43b9-15f9-43f5-9b47-4355af4b2951","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"conversationId\": \"string\",\n \"linkedInAccountId\": 1320,\n \"seen\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/inbox/SetSeenStatus"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 6209,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"}],"_postman_id":"108e2be9-9eb3-497a-8122-9773c4d1b3f4"}],"id":"33bace6c-dcf9-4a66-a70b-e77e0fe357bd","description":"

Methods for working with the HeyReach Inbox. Get and filter conversations and send messages from any of your accounts.

\n","_postman_id":"33bace6c-dcf9-4a66-a70b-e77e0fe357bd"},{"name":"PublicLinkedInAccount","item":[{"name":"GetAll","id":"8a4d2924-d46c-443f-a4df-65216988a091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"keyword\": \"My account name\",\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/li_account/GetAll","description":"

Get a paginated collection of all LinkedIn accounts. Get up to 100 accounts per request.

\n","urlObject":{"path":["api","public","li_account","GetAll"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"f3f2e91e-024f-4786-a489-dacffcfc6235","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/li_account/GetAll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"isActive\": \"\",\n \"activeCampaigns\": \"\",\n \"authIsValid\": \"\",\n \"isValidNavigator\": \"\",\n \"isValidRecruiter\": \"\"\n },\n {\n \"id\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"isActive\": \"\",\n \"activeCampaigns\": \"\",\n \"authIsValid\": \"\",\n \"isValidNavigator\": \"\",\n \"isValidRecruiter\": \"\"\n }\n ]\n}"},{"id":"e89ef8ad-1c80-4149-97fe-16c5de50a111","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/li_account/GetAll"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"d820e7a0-4337-4f8f-93fe-0d55f3db0eb0","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/li_account/GetAll"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"8a4d2924-d46c-443f-a4df-65216988a091"},{"name":"GetById","id":"733dd4a0-37ee-487b-bd3f-bf0333e3a44a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/li_account/GetById?accountId=","description":"

Get a LinkedIn account by id

\n","urlObject":{"path":["api","public","li_account","GetById"],"host":["https://api.heyreach.io"],"query":[{"description":{"content":"

(Required) Id of the account to be returned

\n","type":"text/plain"},"key":"accountId","value":""}],"variable":[]}},"response":[{"id":"454c6f24-ff90-4b3a-96c8-d4ca6b3aaf77","name":"Success","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/li_account/GetById?accountId=","host":["https://api.heyreach.io"],"path":["api","public","li_account","GetById"],"query":[{"description":"(Required) Id of the account to be returned","key":"accountId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"emailAddress\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"isActive\": \"\",\n \"activeCampaigns\": \"\",\n \"authIsValid\": \"\",\n \"isValidNavigator\": \"\",\n \"isValidRecruiter\": \"\"\n}"},{"id":"cc113fa0-792f-45a1-9e12-b3311279861f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/li_account/GetById?accountId=","host":["https://api.heyreach.io"],"path":["api","public","li_account","GetById"],"query":[{"description":"(Required) Id of the account to be returned","key":"accountId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"1b4ed17d-495f-4e02-bd11-9059bf0194d2","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/li_account/GetById?accountId=","host":["https://api.heyreach.io"],"path":["api","public","li_account","GetById"],"query":[{"description":"(Required) Id of the account to be returned","key":"accountId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"d66d694e-56cc-44a7-922a-824770994757","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/li_account/GetById?accountId=","host":["https://api.heyreach.io"],"path":["api","public","li_account","GetById"],"query":[{"description":"(Required) Id of the account to be returned","key":"accountId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"733dd4a0-37ee-487b-bd3f-bf0333e3a44a"}],"id":"ea391a0f-9593-4b20-9774-f82e4189ef2c","description":"

Methods for working with LinkedIn accounts in HeyReach. Filter accounts. Soon to add more methds.

\n","_postman_id":"ea391a0f-9593-4b20-9774-f82e4189ef2c"},{"name":"PublicList","item":[{"name":"GetById","id":"0df73fc9-278b-4fc1-9dba-589ac606bc38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/list/GetById?listId=","description":"

Get a lead or company list by Id

\n","urlObject":{"path":["api","public","list","GetById"],"host":["https://api.heyreach.io"],"query":[{"description":{"content":"

(Required) The Id of the list to be retrieved

\n","type":"text/plain"},"key":"listId","value":""}],"variable":[]}},"response":[{"id":"dbb8ef6c-44ac-4693-b623-3d657fc60b39","name":"Success","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/list/GetById?listId=","host":["https://api.heyreach.io"],"path":["api","public","list","GetById"],"query":[{"description":"(Required) The Id of the list to be retrieved","key":"listId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"totalItemsCount\": \"\",\n \"listType\": null,\n \"creationTime\": \"\",\n \"campaignIds\": [\n \"\",\n \"\"\n ]\n}"},{"id":"8c6d289a-20b5-485d-aa7c-9fd09e1c8492","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/list/GetById?listId=","host":["https://api.heyreach.io"],"path":["api","public","list","GetById"],"query":[{"description":"(Required) The Id of the list to be retrieved","key":"listId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"eda5a60f-3416-4f90-b7a6-cc67972b67ea","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/list/GetById?listId=","host":["https://api.heyreach.io"],"path":["api","public","list","GetById"],"query":[{"description":"(Required) The Id of the list to be retrieved","key":"listId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"948e7e7a-a941-4490-8b86-72b8f3cc8baa","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/list/GetById?listId=","host":["https://api.heyreach.io"],"path":["api","public","list","GetById"],"query":[{"description":"(Required) The Id of the list to be retrieved","key":"listId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"0df73fc9-278b-4fc1-9dba-589ac606bc38"},{"name":"GetAll","id":"c8ef68b4-c329-41ae-8298-72f2336bbb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"keyword\": \"my list name\",\n \"listType\": \"USER_LIST\",\n \"campaignIds\": [123,125],\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetAll","description":"

Get a paginated collection of all company and lead lists. Get up to 100 lists per request.

\n","urlObject":{"path":["api","public","list","GetAll"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"bb5ae4f8-138e-40c0-9d5b-a6b94e33f443","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"listType\": null,\n \"campaignIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetAll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalItemsCount\": \"\",\n \"listType\": null,\n \"creationTime\": \"\",\n \"campaignIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"totalItemsCount\": \"\",\n \"listType\": null,\n \"creationTime\": \"\",\n \"campaignIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n}"},{"id":"c7774888-381c-4d55-bdd1-6ac7b79b37bd","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"listType\": null,\n \"campaignIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetAll"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"bb942145-c8e7-4604-aa2d-9644266cbe48","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"listType\": null,\n \"campaignIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetAll"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"c8ef68b4-c329-41ae-8298-72f2336bbb78"},{"name":"GetLeadsFromList","id":"cb9cabe0-e7e4-4d46-95df-eb194831094e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": 123,\n \"offset\": 0,\n \"keyword\": \"\",\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john-doe/\",\n \"leadLinkedInId\": \"121313fsdf234\",\n \"limit\": 10,\n \"createdFrom\": \"2024-10-06T17:34:00+02:00\",\n \"createdTo\": \"2024-10-07T17:34:00+02:00\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList","description":"

Get a paginated collection of leads from a lead list. Get up to 1000 leads per request.

\n
    \n

  • listId: The id of the lead list.

    \n
    • \n

  • keyword (optional): A search term to filter leads by name or other relevant fields.

    \n
    • \n

  • leadProfileUrl (optional): the linkedIn profile url of the lead, for example 'https://www.linkedin.com/in/john-doe/'

    \n
    • \n

  • leadLinkedInId (string, optional): The LinkedIn ID of the lead. You can find this ID as \"linkedin_id\" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.

    \n
    • \n

  • createdFrom (string, ISO 8601): Specifies the start date and time for filtering leads based on their creation timestamp. Only leads created on or after this date will be included. Can be ommited.

    \n
    • \n

  • createdTo (string, ISO 8601): Specifies the end date and time for filtering leads based on their creation timestamp. Only leads created before or at this date will be included. Can be ommited.

    \n
    • \n
\n","urlObject":{"path":["api","public","list","GetLeadsFromList"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"53c4d5ee-d3c0-4638-bde2-1bb24ab70e78","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"leadProfileUrl\": \"string\",\n \"leadLinkedInId\": \"string\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"profileUrl\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"headline\": \"\",\n \"imageUrl\": \"\",\n \"location\": \"\",\n \"companyName\": \"\",\n \"companyUrl\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"connections\": \"\",\n \"followers\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"emailAddress\": \"\",\n \"customFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"profileUrl\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"headline\": \"\",\n \"imageUrl\": \"\",\n \"location\": \"\",\n \"companyName\": \"\",\n \"companyUrl\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"connections\": \"\",\n \"followers\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"emailAddress\": \"\",\n \"customFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"cbad4bda-64d4-4e45-908a-73a55f98947e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"6b17ca82-8423-4202-a61c-251b7b165819","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"a0a8b666-11c7-41ec-ad2a-2afac81f489c","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"d853ba53-7dd1-47ca-a342-1dbec25ffcc4","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetLeadsFromList"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"cb9cabe0-e7e4-4d46-95df-eb194831094e"},{"name":"DeleteLeadsFromList","id":"3ec57b5e-1204-4822-9921-cfed9d9cfe85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": 3672,\n \"leadMemberIds\": [\"1111\", \"222\"]\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/DeleteLeadsFromList","description":"

Deletes the specified leads from a lead list.

\n

Params:

\n
    \n

  • listId (integer): The ID of the list.

    \n
    • \n

  • leadMemberIds : Array of the LinkedIn IDs of the leads to be deleted. In our API responses, this MemberId can also be named as 'linkedin_id'.

    \n
    • \n
\n","urlObject":{"path":["api","public","list","DeleteLeadsFromList"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ec57b5e-1204-4822-9921-cfed9d9cfe85"},{"name":"DeleteLeadsFromListByProfileUrl","id":"1a3e6a53-0448-41f2-8ef1-9fbad37d0d7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": 3672,\n \"profileUrls\": [\n \"https://www.linkedin.com/in/john-doe/\",\n \"https://www.linkedin.com/in/jane-doe/\" \n ]\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/DeleteLeadsFromListByProfileUrl","description":"

Deletes the specified leads from a lead list by LinkedIn profile url.

\n

Params:

\n
    \n

  • listId (integer): The ID of the list.

    \n
    • \n

  • profileUrls: Array of LinkedIn urls of the leads to be deleted.

    \n
    • \n
\n

NOTE: this endpoint will return OK(200) even if the leads are not found in the list.
If leads are not found in the list, they will be returned in the response, in the field 'notFoundInList' which will consist only the 'username', not the whole url. (see the example response)

\n","urlObject":{"path":["api","public","list","DeleteLeadsFromListByProfileUrl"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"fd6d2047-d5b1-4842-86d1-81d50c02c8af","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": 3672,\n \"profileUrls\": [\n \"https://www.linkedin.com/in/john-doe/\",\n \"https://www.linkedin.com/in/jane-doe/\" \n ]\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/DeleteLeadsFromListByProfileUrl"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"notFoundInList\": [\r\n \"jane-doe\"\r\n ]\r\n}"}],"_postman_id":"1a3e6a53-0448-41f2-8ef1-9fbad37d0d7b"},{"name":"GetCompaniesFromList","id":"d5e62420-0586-4931-b0f1-bb5b00ba9515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": 123,\n \"offset\": 0,\n \"keyword\": \"HeyReach\",\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList","description":"

Get a paginated collection of companies from a company list. Get up to 1000 companies per request.

\n","urlObject":{"path":["api","public","list","GetCompaniesFromList"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"6ee6c293-fbaa-4971-93b0-f3263bab2e69","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"industry\": \"\",\n \"imageUrl\": \"\",\n \"companySize\": \"\",\n \"employeesOnLinkedIn\": \"\",\n \"location\": \"\",\n \"specialities\": \"\",\n \"website\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"industry\": \"\",\n \"imageUrl\": \"\",\n \"companySize\": \"\",\n \"employeesOnLinkedIn\": \"\",\n \"location\": \"\",\n \"specialities\": \"\",\n \"website\": \"\"\n }\n ]\n}"},{"id":"648107b7-f982-46c1-ba1f-b8bd46a2716c","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"7512229b-0ac7-4f25-84fa-e91dc8a97aad","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"0d801a9a-81a1-4b6c-b507-723fafe3b263","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"f9963c60-9fa2-4a60-bc84-4140f46a39c9","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"listId\": \"\",\n \"offset\": \"\",\n \"keyword\": \"\",\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetCompaniesFromList"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"d5e62420-0586-4931-b0f1-bb5b00ba9515"},{"name":"AddLeadsToList","id":"5debdfd7-30db-4a63-a915-1a0fa3f6cc95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n ],\n \"listId\": 123\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList","description":"

Add leads to a lead list. Add up to 100 leads per request.

\n

The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores _. An error will be return in the case the name field does not follow this format.

\n

Be aware that adding leads to a list is not the same as addig them to a campaign. If the campaign is in a finished state or has already used all the leads in it, then leads added to the list will not be started in the campaign. If you want to add the leads to a specific campaign, then use the AddLeadsToCampaign or AddLeadsToCampaignV2 methods.

\n","urlObject":{"path":["api","public","list","AddLeadsToList"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"272df927-3ea6-492b-abda-b59e44cd53a1","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"0"},{"id":"f03ad6e9-0c53-4e50-9ed8-ec005db81679","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"bfa99f3e-e6bf-4406-bee8-42cc35d7032f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"b7703a2c-52b9-4f31-a389-d5160ab2f8ce","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"c39c5995-682d-4c6e-81fd-84c81e5f6307","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToList"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"5debdfd7-30db-4a63-a915-1a0fa3f6cc95"},{"name":"AddLeadsToListV2","id":"b1c5d588-09e6-4085-aafc-5a1b3a92d81a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n ],\n \"listId\": 123\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2","description":"

Add leads to a lead list. Add up to 100 leads per request. Same as the AddLeadsToList request, however this request returns counts for how many of the leads were added, how many were update and how many failed to be added.

\n

The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores _. An error will be return in the case the name field does not follow this format.

\n

Be aware that adding leads to a list is not the same as adding them to a campaign. If the campaign is in a finished state or has already used all the leads in it, then leads added to the list will not be started in the campaign. If you want to add the leads to a specific campaign, then use the AddLeadsToCampaign or AddLeadsToCampaignV2 methods.

\n","urlObject":{"path":["api","public","list","AddLeadsToListV2"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"6d8e36b4-e362-40d7-a34d-6b523540c10e","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"addedLeadsCount\": 10,\r\n \"updatedLeadsCount\": 1,\r\n \"failedLeadsCount\": 0\r\n}"},{"id":"c4498aeb-74b2-43b3-8fdb-8629ecdce447","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"f5949183-2863-4f9c-a805-9a906bb46eee","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"dac588e3-292e-4bb4-95aa-61f619587d01","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"d092d1f5-f237-44ea-93a6-83be5fc9d322","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leads\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"listId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/AddLeadsToListV2"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"b1c5d588-09e6-4085-aafc-5a1b3a92d81a"},{"name":"GetListsForLead","id":"90e1275b-a7a1-434c-83b8-bed5da4f9e24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john_doe@example.com\",\n \"linkedinId\": \"121313fsdf234\",\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"offset\": 0,\n \"limit\": 100\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetListsForLead","description":"

Gets Lists for a Lead

\n

This endpoint retrieves the lists associated with a specific lead.

\n

Remark: The response will include lead lists that match the provided lead details such as email, LinkedIn ID, or profile URL.

\n

Body Parameters

\n
    \n

  • email (string, optional): The email address of the lead.

    \n
    • \n

  • linkedinId (string, optional): The LinkedIn ID of the lead.

    \n
    • \n

  • profileUrl (string, optiona;): The LinkedIn profile URL of the lead. For example: https://www.linkedin.com/in/john_doe/

    \n
    • \n

  • offset (integer): The number of records to skip (for pagination).

    \n
    • \n

  • limit (integer): The maximum number of records to return.

    \n
    • \n
\n","urlObject":{"path":["api","public","list","GetListsForLead"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"f46585f0-696d-4f0d-8807-3a99860115b8","name":"GetListsForLead","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"linkedinId\": \"\",\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"offset\": 0,\n \"limit\": 100\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/GetListsForLead"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 2,\r\n \"items\": [\r\n {\r\n \"listId\": 3457,\r\n \"listName\": \"Veterans in USA\"\r\n },\r\n {\r\n \"listId\": 3468,\r\n \"listName\": \"Rich and Famous\"\r\n }\r\n ]\r\n}"}],"_postman_id":"90e1275b-a7a1-434c-83b8-bed5da4f9e24"},{"name":"CreateEmptyList","id":"69288286-5cfd-4d5b-9a7e-e758ebbdc988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList","description":"

Create an empty lead or company list. You pass the list name and the list type (USER_LIST or COMPANY_LIST). If the type value is left empty, a Lead list will be created by default.

\n","urlObject":{"path":["api","public","list","CreateEmptyList"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"dfa789f5-15ea-48c7-864e-a5ce98394e8c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 123,\r\n \"name\": \"My List\",\r\n \"count\": 0,\r\n \"listType\": \">\",\r\n \"creationTime\": \"2024-08-29T09:34:56.5417789Z\",\r\n \"isDeleted\": false,\r\n \"campaigns\": null,\r\n \"search\": null,\r\n \"status\": \"UNKNOWN\"\r\n}"},{"id":"79e116d5-6338-403c-9612-65841b6d89ea","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"358144a2-3c2d-4f78-a5cf-9700d070b573","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"55253eed-f4ce-463c-bd0a-2635d61d83de","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList1"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"705a59e4-e1c7-4e91-8b33-c84158a1cfd9","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/list/CreateEmptyList"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"69288286-5cfd-4d5b-9a7e-e758ebbdc988"}],"id":"f08e6bf5-3dfd-47b6-8d9b-4ce318a06d5a","description":"

Methods for working with HeyReach lists. Get leads and companies from lists. And add leads to a list.

\n","_postman_id":"f08e6bf5-3dfd-47b6-8d9b-4ce318a06d5a"},{"name":"PublicStats","item":[{"name":"Get Overall Stats","id":"8c02512f-be8e-4a33-aee0-40af7428aaf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountIds\": [1234],\r\n \"campaignIds\": [],\r\n \"startDate\": \"2024-12-17T00:00:00.000Z\",\r\n \"endDate\": \"2024-12-19T23:59:59.999Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/stats/GetOverallStats","description":"

Gets the overall stats for the specified filters.

\n
    \n

  • Method: POST

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n
\n

Request Body

\n
    \n

  • accountIds: Array of Ids of the LinkedIn senders. If empty - all the senders will be included.

    \n
    • \n

  • campaignIds: Array of the Ids of the campaigns to be included. If empty - all the campaigns will be included.

    \n
    • \n

  • startDate:

    \n
    • \n

  • endDate:

    \n
    • \n
\n

{
\"accountIds\": [1234],
\"campaignIds\": [],
\"startDate\": \"2024-12-17T00:00:00.000Z\",
\"endDate\": \"2024-12-19T23:59:59.999Z\"
}

\n","urlObject":{"path":["api","public","stats","GetOverallStats"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"43036bbe-45bc-4475-85ba-9a47e0a7c6c2","name":"Get Overall Stats","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountIds\": [1234],\r\n \"campaignIds\": [],\r\n \"startDate\": \"2024-12-17T00:00:00.000Z\",\r\n \"endDate\": \"2024-12-19T23:59:59.999Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.heyreach.io/api/public/stats/GetOverallStats"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"byDayStats\": {\r\n \"2024-12-17T00:00:00Z\": {\r\n \"profileViews\": 0,\r\n \"postLikes\": 0,\r\n \"follows\": 0,\r\n \"messagesSent\": 723,\r\n \"totalMessageStarted\": 593,\r\n \"totalMessageReplies\": 136,\r\n \"inmailMessagesSent\": 0,\r\n \"totalInmailStarted\": 0,\r\n \"totalInmailReplies\": 0,\r\n \"connectionsSent\": 4650,\r\n \"connectionsAccepted\": 637,\r\n \"messageReplyRate\": 0.22934233,\r\n \"inMailReplyRate\": 0.0,\r\n \"connectionAcceptanceRate\": 0.13698925\r\n },\r\n \"2024-12-18T00:00:00Z\": {\r\n \"profileViews\": 0,\r\n \"postLikes\": 0,\r\n \"follows\": 0,\r\n \"messagesSent\": 1033,\r\n \"totalMessageStarted\": 592,\r\n \"totalMessageReplies\": 119,\r\n \"inmailMessagesSent\": 0,\r\n \"totalInmailStarted\": 0,\r\n \"totalInmailReplies\": 0,\r\n \"connectionsSent\": 5161,\r\n \"connectionsAccepted\": 652,\r\n \"messageReplyRate\": 0.20101352,\r\n \"inMailReplyRate\": 0.0,\r\n \"connectionAcceptanceRate\": 0.1263321\r\n },\r\n \"2024-12-19T00:00:00Z\": {\r\n \"profileViews\": 0,\r\n \"postLikes\": 0,\r\n \"follows\": 0,\r\n \"messagesSent\": 845,\r\n \"totalMessageStarted\": 581,\r\n \"totalMessageReplies\": 140,\r\n \"inmailMessagesSent\": 0,\r\n \"totalInmailStarted\": 0,\r\n \"totalInmailReplies\": 0,\r\n \"connectionsSent\": 4929,\r\n \"connectionsAccepted\": 539,\r\n \"messageReplyRate\": 0.24096386,\r\n \"inMailReplyRate\": 0.0,\r\n \"connectionAcceptanceRate\": 0.10935281\r\n }\r\n },\r\n \"overallStats\": {\r\n \"profileViews\": 0,\r\n \"postLikes\": 0,\r\n \"follows\": 0,\r\n \"messagesSent\": 2601,\r\n \"totalMessageStarted\": 1766,\r\n \"totalMessageReplies\": 395,\r\n \"inmailMessagesSent\": 0,\r\n \"totalInmailStarted\": 0,\r\n \"totalInmailReplies\": 0,\r\n \"connectionsSent\": 14740,\r\n \"connectionsAccepted\": 1828,\r\n \"messageReplyRate\": 0.2236693,\r\n \"inMailReplyRate\": 0.0,\r\n \"connectionAcceptanceRate\": 0.124016285\r\n }\r\n}"}],"_postman_id":"8c02512f-be8e-4a33-aee0-40af7428aaf6"}],"id":"2fd8d019-ab82-4d58-8dd2-d7ada80da392","_postman_id":"2fd8d019-ab82-4d58-8dd2-d7ada80da392","description":""},{"name":"PublicLead","item":[{"name":"GetLead","id":"61f5ef5d-5f31-4da9-b6af-ef0a6f128146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/GetLead","description":"

Gets Lead Details

\n

This endpoint retrieves the details of a specific lead based on their LinkedIn profile URL.

\n

Remark: The response will provide detailed information about the lead that matches the specified profile URL.

\n

Body Parameters

\n
    \n
  • profileUrl (string): The LinkedIn profile URL of the lead. This parameter is required.
    • \n
\n","urlObject":{"path":["api","public","lead","GetLead"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"6da347db-c726-44eb-a7fa-217ba6abc225","name":"GetLead","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/GetLead"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"linkedin_id\": \"63456789\",\r\n \"imageUrl\": \"https://media.licdn.com/dms/image/v2/some_url\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"fullName\": \"John Doe\",\r\n \"location\": \"Texas\",\r\n \"summary\": \"\",\r\n \"companyName\": \"Marines\",\r\n \"companyUrl\": \"https://www.linkedin.com/company/marines\",\r\n \"position\": \"Director of Marines\",\r\n \"industry\": null,\r\n \"about\": null,\r\n \"username\": \"john_doe\",\r\n \"emailAddress\": null,\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"experiences\": \"[]\",\r\n \"education\": \"[]\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe\",\r\n \"enrichedEmailAddress\": \"john_doe@example.com\",\r\n \"headline\": null,\r\n \"emailEnrichments\": [\r\n \"john_doe@example.com\"\r\n ]\r\n}"}],"_postman_id":"61f5ef5d-5f31-4da9-b6af-ef0a6f128146"},{"name":"AddTags","id":"7fc21128-a9ab-4d7d-83f9-c7633654b3b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"leadLinkedInId\": \"\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"createTagIfNotExisting\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/AddTags","description":"

Add Tags to Lead

\n

Adds tags to the lead. Existing tags will not be changed.

\n
    \n

  • leadProfileUrl (optional): the linkedIn profile url of the lead, for example 'https://www.linkedin.com/in/john-doe/'

    \n
    • \n

  • leadLinkedInId (string, optional): The LinkedIn ID of the lead. You can find this ID as \"linkedin_id\" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.

    \n
    • \n

  • tags (string array): The tags to be added to the lead.

    \n
    • \n

  • createTagIfNotExisting (boolean): If true, creates tags that don't exist. if false and there is a tag that does not exist, \"Bad Request\" will be returned.

    \n
    • \n
\n","urlObject":{"path":["api","public","lead","AddTags"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"e133d887-a7d7-4af7-a43e-9825ff162857","name":"AddTags","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"leadLinkedInId\": \"\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"createTagIfNotExisting\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/AddTags"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"newAssignedTags\": [\r\n \"tag2\"\r\n ]\r\n}"}],"_postman_id":"7fc21128-a9ab-4d7d-83f9-c7633654b3b5"},{"name":"GetTags","id":"35f5f1cd-3536-483b-b09d-9b3f58bf3f35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/GetTags","description":"

Get Tags for a Lead

\n

Gets the tags for a lead. The tags are alphabetically sorted.

\n\n","urlObject":{"path":["api","public","lead","GetTags"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"45716d7c-a550-4702-8ebb-360eb6f2276a","name":"GetTags","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe/\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/GetTags"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"tags\": [\r\n \"atag1\"\r\n \"btag2\",\r\n \"ctag3\"\r\n ]\r\n}"}],"_postman_id":"35f5f1cd-3536-483b-b09d-9b3f58bf3f35"},{"name":"ReplaceTags","id":"c491eee8-f976-4a93-8401-d060bf46104c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"leadLinkedInId\": \"\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"createTagIfNotExisting\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/ReplaceTags","description":"

Replaces Tags to Lead

\n

Removes the existing tags and replaces with the new tags.

\n
    \n

  • leadProfileUrl (optional): the linkedIn profile url of the lead, for example 'https://www.linkedin.com/in/john-doe/'

    \n
    • \n

  • leadLinkedInId (string, optional): The LinkedIn ID of the lead. You can find this ID as \"linkedin_id\" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.

    \n
    • \n

  • tags (string array): The tags to be added to the lead.

    \n
    • \n

  • createTagIfNotExisting (boolean): If true, creates tags that don't exist. if false and there is a tag that does not exist, \"Bad Request\" will be returned.

    \n
    • \n
\n","urlObject":{"path":["api","public","lead","ReplaceTags"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"86efaf8f-00f8-425f-bf64-e383fd200220","name":"ReplaceTags","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"leadLinkedInId\": \"\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"createTagIfNotExisting\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead/ReplaceTags"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"newAssignedTags\": [\r\n \"tag1\",\r\n \"tag2\"\r\n ]\r\n}"}],"_postman_id":"c491eee8-f976-4a93-8401-d060bf46104c"}],"id":"d5232ccc-a2d1-43b5-afc4-51a834354d56","_postman_id":"d5232ccc-a2d1-43b5-afc4-51a834354d56","description":""},{"name":"LeadTags","item":[{"name":"CreateTags","id":"39ba77ba-c4f7-4a38-a695-aed257444851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Public API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n {\n \"displayName\": \"string\",\n \"color\": \"Blue|Green|Purple|Pink|Red|Cyan|Yellow|Orange\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead_tags/CreateTags","description":"

Create one or multiple tags for your workspace. You can assign these tags to leads. Available colors: Blue, Green, Purple, Pink, Red, Cyan, Yellow, Orange.

\n","urlObject":{"path":["api","public","lead_tags","CreateTags"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"f93604b6-e14f-4e40-945c-84f54600f9c5","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n {\n \"displayName\": \"string\",\n \"color\": \"Green\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead_tags/CreateTags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"displayName\": \"string\",\n \"color\": \"Purple\"\n },\n {\n \"displayName\": \"stri\",\n \"color\": \"Purple\"\n }\n]"},{"id":"bf1738c2-cda1-4cb3-8733-15e9099bd24a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n {\n \"displayName\": \"string\",\n \"color\": \"Green\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead_tags/CreateTags"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9618,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"da953dcd-d541-41da-923b-eaee79576264","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n {\n \"displayName\": \"string\",\n \"color\": \"Green\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead_tags/CreateTags"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"string\"\n}"},{"id":"51a1bf70-783b-4070-9dff-dd409360ea09","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Public API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n {\n \"displayName\": \"string\",\n \"color\": \"Green\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/lead_tags/CreateTags"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9618,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"}],"_postman_id":"39ba77ba-c4f7-4a38-a695-aed257444851"}],"id":"fcb879cb-f39f-429f-a5a9-f177b45933f7","_postman_id":"fcb879cb-f39f-429f-a5a9-f177b45933f7","description":""},{"name":"PublicWebhooks","item":[{"name":"Create Webhook","id":"e1163c53-783b-463c-a4e7-deb279093ec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"webhookName\": \"string\",\n \"webhookUrl\": \"string\",\n \"eventType\": \"CONNECTION_REQUEST_SENT\" | \"CONNECTION_REQUEST_ACCEPTED\" | \"MESSAGE_SENT\" | \n \"MESSAGE_REPLY_RECEIVED\" | \"INMAIL_SENT\" | \"INMAIL_REPLY_RECEIVED\" | \"FOLLOW_SENT\" | \n \"LIKED_POST\" | \"VIEWED_PROFILE\" | \"CAMPAIGN_COMPLETED\" | \"LEAD_TAG_UPDATED\" | \n \"EVERY_MESSAGE_REPLY_RECEIVED\"\n \"campaignIds\": []\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/CreateWebhook","description":"

Create Webhook

\n

Endpoint
POST https://api.heyreach.io/api/public/webhooks/CreateWebhook

\n

Description
This API creates a new webhook that listens to specified events, optionally filtered by campaign IDs.

\n
\n

Request Body Example

\n
{\n  \"webhookName\": \"string\",\n  \"webhookUrl\": \"string\",\n  \"eventType\": \"CONNECTION_REQUEST_SENT\" | \"CONNECTION_REQUEST_ACCEPTED\" | \"MESSAGE_SENT\" | \n                \"MESSAGE_REPLY_RECEIVED\" | \"INMAIL_SENT\" | \"INMAIL_REPLY_RECEIVED\" | \"FOLLOW_SENT\" | \n                \"LIKED_POST\" | \"VIEWED_PROFILE\" | \"CAMPAIGN_COMPLETED\" | \"LEAD_TAG_UPDATED\" | \n                \"EVERY_MESSAGE_REPLY_RECEIVED\"\n  \"campaignIds\": []\n}\n\n
\n

Request Parameters

\n
    \n

  • webhookName (string): The name of the webhook.

    \n
    • \n

  • webhookUrl (string): The URL to which the webhook will send POST requests.

    \n
    • \n

  • eventType (string): The type of event that triggers the webhook. It must be one of the following values:

    \n
      \n

    • CONNECTION_REQUEST_SENT

      \n
      • \n

    • CONNECTION_REQUEST_ACCEPTED

      \n
      • \n

    • MESSAGE_SENT

      \n
      • \n

    • MESSAGE_REPLY_RECEIVED (only the first reply)

      \n
      • \n

    • INMAIL_SENT

      \n
      • \n

    • INMAIL_REPLY_RECEIVED(only the first reply)

      \n
      • \n

    • EVERY_MESSAGE_REPLY_RECEIVED (including repliies for both messages and inmails)

      \n
      • \n

    • FOLLOW_SENT

      \n
      • \n

    • LIKED_POST

      \n
      • \n

    • VIEWED_PROFILE

      \n
      • \n

    • CAMPAIGN_COMPLETED

      \n
      • \n

    • LEAD_TAG_UPDATED

      \n
      • \n
    \n
    • \n

  • campaignIds (array): A list of campaign IDs. If this array is empty, the webhook will listen for the specified eventType across all campaigns. If specific campaign IDs are provided, the webhook will listen only to those campaigns.

    \n
    • \n
\n","urlObject":{"path":["api","public","webhooks","CreateWebhook"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1163c53-783b-463c-a4e7-deb279093ec0"},{"name":"Get Webhook By Id","id":"8e7d7f3f-0a10-4316-aaab-2f8b8a97a9b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/GetWebhookById?webhookId=123","description":"

Get Webhook By Id

\n

Description
Get a webhook by Id.

\n","urlObject":{"path":["api","public","webhooks","GetWebhookById"],"host":["https://api.heyreach.io"],"query":[{"key":"webhookId","value":"123"}],"variable":[]}},"response":[{"id":"06e03e7d-1ab6-48e4-aef1-1a86561a3fa8","name":"Get Webhook By Id","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/webhooks/GetWebhookById?webhookId=123","host":["https://api.heyreach.io"],"path":["api","public","webhooks","GetWebhookById"],"query":[{"key":"webhookId","value":"123"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 123,\r\n \"webhookName\": \"My Webhook Name\",\r\n \"webhookUrl\": \"https://webhook.site/my-webhook-url\",\r\n \"eventType\": \"CONNECTION_REQUEST_SENT\",\r\n \"campaignIds\": [\r\n 123, 124\r\n ],\r\n \"isActive\": true\r\n}"}],"_postman_id":"8e7d7f3f-0a10-4316-aaab-2f8b8a97a9b0"},{"name":"GetAllWebhooks","id":"633d7b1c-f578-4f4a-b0dd-8a01bf8b7694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/GetAllWebhooks","description":"

Get All Webhooks

\n

Description
Get all webhooks.

\n","urlObject":{"path":["api","public","webhooks","GetAllWebhooks"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"54876400-0e8d-452a-a6d5-737fde8b2d8c","name":"GetAllWebhooks","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/GetAllWebhooks"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 1,\r\n \"items\": [\r\n {\r\n \"id\": 123,\r\n \"webhookName\": \"string\",\r\n \"webhookUrl\": \"string\",\r\n \"eventType\": \"CONNECTION_REQUEST_SENT\",\r\n \"campaignIds\": [\r\n 123\r\n ],\r\n \"isActive\": true\r\n }\r\n ]\r\n}"}],"_postman_id":"633d7b1c-f578-4f4a-b0dd-8a01bf8b7694"},{"name":"Update Webhook","id":"759fa491-920e-42af-90ca-80b4dd820711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"webhookName\": \"string\" | null,\n \"webhookUrl\": \"string\" | null,\n \"eventType\": \"CONNECTION_REQUEST_SENT\" | \"CONNECTION_REQUEST_ACCEPTED\" | \"MESSAGE_SENT\" | \"MESSAGE_REPLY_RECEIVED\" | \"INMAIL_SENT\" | \"INMAIL_REPLY_RECEIVED\" | \"FOLLOW_SENT\" | \"LIKED_POST\" | \"VIEWED_PROFILE\" | \"CAMPAIGN_COMPLETED\" | \"LEAD_TAG_UPDATED\" | null\n \"campaignIds\": [] | null\n \"isActive\": true | null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/UpdateWebhook?webhookId=1234","description":"

Update Webhook

\n

Endpoint
PATCH https://api.heyreach.io/api/public/webhooks/UpdateWebhook?webhookId=1234

\n

Description
This API updates an existing webhook by modifying its configuration, such as name, URL, event type, associated campaigns, and status.

\n
\n

Query Parameters

\n
    \n
  • webhookId (string): The unique identifier of the webhook to update. This must be provided as a query parameter.
    • \n
\n
\n

Request Body Example

\n
{\n  \"webhookName\": \"string\",\n  \"webhookUrl\": \"string\",\n  \"eventType\": \"CONNECTION_REQUEST_SENT\",\n  \"campaignIds\": [],\n  \"isActive\": true\n}\n\n
\n

Request Parameters

\n
    \n

  • webhookName (string): The name of the webhook. If NULL or ommited, the original name will be kept.

    \n
    • \n

  • webhookUrl (string): The URL to which the webhook will send POST requests. If NULL or ommited, the orignal url will be kept

    \n
    • \n

  • eventType (string): The type of event that triggers the webhook. If null or ommited, the original will be kept.
    It must be one of the following values:

    \n
      \n

    • CONNECTION_REQUEST_SENT

      \n
      • \n

    • CONNECTION_REQUEST_ACCEPTED

      \n
      • \n

    • MESSAGE_SENT

      \n
      • \n

    • MESSAGE_REPLY_RECEIVED

      \n
      • \n

    • INMAIL_SENT

      \n
      • \n

    • INMAIL_REPLY_RECEIVED

      \n
      • \n

    • FOLLOW_SENT

      \n
      • \n

    • LIKED_POST

      \n
      • \n

    • VIEWED_PROFILE

      \n
      • \n

    • CAMPAIGN_COMPLETED

      \n
      • \n

    • LEAD_TAG_UPDATED

      \n
      • \n
    \n
    • \n

  • campaignIds (array): A list of campaign IDs.
    If null or ommited, the original array will be kept.
    If this array is empty, the webhook will listen for the specified eventType across all campaigns. If specific campaign IDs are provided, the webhook will listen only to those campaigns.

    \n
    • \n

  • isActive (boolean | null): Determines whether the webhook should be active. If true, the webhook is enabled; if false, it is disabled. If null, the activation status remains unchanged.

    \n
    • \n
\n","urlObject":{"path":["api","public","webhooks","UpdateWebhook"],"host":["https://api.heyreach.io"],"query":[{"key":"webhookId","value":"1234"}],"variable":[]}},"response":[],"_postman_id":"759fa491-920e-42af-90ca-80b4dd820711"},{"name":"Delete Webhook","id":"fff5d3c0-e6be-4608-ada8-8d629fa57085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/webhooks/DeleteWebhook?webhookId=1234","description":"

Delete Webhook

\n

Endpoint
Delete https://api.heyreach.io/api/public/webhooks/DeleteWebhook?webhookId=1234

\n

Description
This API deletes an existing webhook.

\n
\n

Query Parameters

\n
    \n
  • webhookId (string): The unique identifier of the webhook to delete. This must be provided as a query parameter.
    • \n
\n
\n","urlObject":{"path":["api","public","webhooks","DeleteWebhook"],"host":["https://api.heyreach.io"],"query":[{"key":"webhookId","value":"1234"}],"variable":[]}},"response":[],"_postman_id":"fff5d3c0-e6be-4608-ada8-8d629fa57085"}],"id":"15dcd7a8-5d28-4a3c-bf35-998b37a831e5","_postman_id":"15dcd7a8-5d28-4a3c-bf35-998b37a831e5","description":""},{"name":"PublicMyNetwork","item":[{"name":"GetMyNetworkForSender","id":"e915fb18-68b1-4641-98d6-78281c2c4571","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"pageNumber\": 0,\n \"pageSize\": 100,\n \"senderId\": 1234\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/MyNetwork/GetMyNetworkForSender","description":"

GetMyNetworkForSender

\n

Endpoint
POST /api/public/MyNetwork/GetMyNetworkForSender

\n

Description
Gets paginated list of the network for the specified sender

\n
\n

Request Body Example

\n
{\n  \"pageNumber\": 0,\n  \"pageSize\": 100,\n  \"senderId\": 1234\n}\n\n
\n

StartFragment

\n

Request Parameters

\n
    \n
  • senderId (number): The id of the sender account for which to retrieve the network
    • \n
\n","urlObject":{"path":["api","public","MyNetwork","GetMyNetworkForSender"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"83041f6e-01d7-4be7-94cc-b0075a06ab7e","name":"GetMyNetworkForSender","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"pageNumber\": 0,\n \"pageSize\": 100,\n \"senderId\": 1234\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/MyNetwork/GetMyNetworkForSender"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"totalCount\": 40,\r\n \"items\": [\r\n {\r\n \"linkedin_id\": \"6259333\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe-1\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"headline\": null,\r\n \"imageUrl\": \"https://media.licdn.com/dms/image/v2/764806400&v=beta&t=AqQ71ae2Oq7OGFRFL_j_6ihM5d0QSL_uiJIJmPuTD7w\",\r\n \"location\": \"USA\",\r\n \"companyName\": \"Army\",\r\n \"companyUrl\": null,\r\n \"position\": \"Senior Software Developer\",\r\n \"about\": null,\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"emailAddress\": null,\r\n \"enrichedEmailAddress\": null,\r\n \"customEmailAddress\": null\r\n },\r\n {\r\n \"linkedin_id\": \"2207777\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe-2\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"headline\": null,\r\n \"imageUrl\": \"https://media.licdn.com/dms/image/v2/_u_5b-ik7oUwKDvZDJ1nvoioIMx0-vpJRXE\",\r\n \"location\": null,\r\n \"companyName\": null,\r\n \"companyUrl\": null,\r\n \"position\": null,\r\n \"about\": null,\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"emailAddress\": null,\r\n \"enrichedEmailAddress\": null,\r\n \"customEmailAddress\": null\r\n }\r\n ]\r\n}"}],"_postman_id":"e915fb18-68b1-4641-98d6-78281c2c4571"},{"name":"IsConnection","id":"5bf1bd9b-5e9c-4c6a-bcfc-2420b2d59ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"senderAccountId\": 0,\n \"leadProfileUrl\": \"string\",\n \"leadLinkedInId\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/MyNetwork/IsConnection","description":"

IsConnection

\n

Endpoint
POST /api/public/MyNetwork/IsConnection

\n

Description
Gets a value indicating if the lead is a connection to the sender

\n
\n

Request Body Example

\n
{\n  \"senderAccountId\": 0,\n  \"leadProfileUrl\": \"string\",\n  \"leadLinkedInId\": \"string\"\n}\n\n
\n

StartFragment

\n

Request Parameters

\n
    \n

  • senderId (number): The id of the sender account for which to check.

    \n
    • \n

  • leadProfileUrl (optional): The linkedIn url lead.

    \n
    • \n

  • leadLinkedInId (optional): The linkedIn id of the lead.

    \n

    Either leadProfileUrl or leadLinkedInId should be specified in the request, if both are specified there will be an error.

    \n
    • \n
\n","urlObject":{"path":["api","public","MyNetwork","IsConnection"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"b6e3a476-3c87-47c7-977c-a1b3a3008b19","name":"IsConnection","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"senderAccountId\": 0,\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"leadLinkedInId\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/MyNetwork/IsConnection"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"isConnection\": true\r\n}"}],"_postman_id":"5bf1bd9b-5e9c-4c6a-bcfc-2420b2d59ac4"}],"id":"67ad829f-787b-4806-a865-19f6a4b7a7c2","_postman_id":"67ad829f-787b-4806-a865-19f6a4b7a7c2","description":""},{"name":"Organization","item":[{"name":"Workspace API Keys","item":[{"name":"GetWorkspaceApiKeys","id":"5e6671ff-9d8e-4032-b96d-861221e7b914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","description":"

Get Public API, Make, Zapier, N8N and other relevant integration keys for a given workspace.

\n","urlObject":{"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"type":"any","value":"5421","key":"workspaceId"}]}},"response":[{"id":"65351524-18bf-44a2-bc1e-49a0d48cb9f4","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apiKeys\": {\n \"publicApi\": \"string\",\n \"n8N\": \"string\",\n \"make\": \"string\",\n \"zapier\": \"string\",\n \"mcp\": \"string\"\n }\n}"},{"id":"dde43de4-dec2-44f2-a74d-0db0ac5ad0a3","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"e4907a0c-2c8a-4026-9d82-1f8efc49f45a","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"}],"_postman_id":"5e6671ff-9d8e-4032-b96d-861221e7b914"},{"name":"CreateWorkspaceApiKeys","id":"76827541-36b3-4468-acfd-21468a1ec384","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"apiKeyType\": \"PUBLIC|N8N|MAKE|ZAPIER|MCP\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","description":"

Generate new API/Integration (Make, Zapier, N8N etc...) keys in a given workspace. Available API key types: PUBLIC, N8N, MAKE, ZAPIER, MCP

\n","urlObject":{"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"type":"any","value":"5421","key":"workspaceId"}]}},"response":[{"id":"390b9d27-e0b4-4ebf-b0b1-58e4b479f605","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"apiKeyType\": \"ZAPIER\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"string\",\n \"previousKeyStatus\": \"Deactivated\"\n}"},{"id":"5b205c37-3667-4564-bd50-e97041dccc0a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"apiKeyType\": \"ZAPIER\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"65ae49df-1021-4b50-9bb8-9edfd8c7d638","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"apiKeyType\": \"ZAPIER\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/api-keys/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","api-keys","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"}],"_postman_id":"76827541-36b3-4468-acfd-21468a1ec384"}],"id":"413b0e9a-9ca3-4bee-8aa0-8915ca4106b7","_postman_id":"413b0e9a-9ca3-4bee-8aa0-8915ca4106b7","description":""},{"name":"Workspaces","item":[{"name":"GetAllWorkspaces","id":"a66dffad-f263-4e62-96f8-3675392afcfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","description":"

List all workspaces in your organization.

\n","urlObject":{"path":["api","public","management","organizations","workspaces"],"host":["https://api.heyreach.io"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}],"variable":[]}},"response":[{"id":"0fad967d-a489-43a3-8b1c-35062649833c","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": 2724,\n \"items\": [\n {\n \"workspaceId\": 4395,\n \"workspaceName\": \"string\",\n \"seatsLimit\": 4371,\n \"usedSeats\": 9646\n },\n {\n \"workspaceId\": 6265,\n \"workspaceName\": \"string\",\n \"seatsLimit\": 2637,\n \"usedSeats\": 9005\n }\n ]\n}"},{"id":"6e2d9f8e-c46c-42b7-92be-5bbcae399e11","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"1e38e5a5-ac4c-4cd7-9349-fe7bb493f55a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"7ed00d9d-e5b6-4d97-a590-31d9c8ad4d69","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"c43844ba-130c-4cc3-8083-2452be409686","name":"Server Error","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces?Offset=9109&Limit=66","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces"],"query":[{"key":"Offset","value":"9109"},{"key":"Limit","value":"66"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a66dffad-f263-4e62-96f8-3675392afcfd"},{"name":"CreateWorkspace","id":"464b5667-b901-405d-a908-1ba69b678414","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces","description":"

Create new workspace in your organization

\n","urlObject":{"path":["api","public","management","organizations","workspaces"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"47819877-9dc6-4f18-973e-c5c68258f514","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"workspaceId\": 147,\n \"workspaceName\": \"string\",\n \"seatsLimit\": 8114\n}"},{"id":"3cbaab61-e3c7-470c-b368-0ceed1ba2add","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"62bea288-56b9-4010-88d5-c1684fd8390b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"e65268a0-d523-4668-a77c-771ac3d85a01","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"7cf89608-3da6-499c-8fed-33f2799cb06e","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"464b5667-b901-405d-a908-1ba69b678414"},{"name":"UpdateWorkspace","id":"1c043909-b95d-4ddb-8387-44ec9102eaf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","description":"

Update a given workspace in your organization.

\n","urlObject":{"path":["api","public","management","organizations","workspaces",":workspaceId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"type":"any","value":"3642","key":"workspaceId"}]}},"response":[{"id":"0a8f3cef-2aeb-4c3e-a110-030452bbca92","name":"Success","originalRequest":{"method":"PATCH","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"3642"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"workspaceId\": 9419,\n \"workspaceName\": \"string\",\n \"seatsLimit\": 2983,\n \"usedSeats\": 9967\n}"},{"id":"235b6c12-5ac9-45ab-89d5-4ece4ddd44f0","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"3642"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"5484c8ad-c521-4193-9289-5459e6f092be","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"3642"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"609a6106-6d27-4542-a347-1ce7345d1889","name":"Too Many Requests","originalRequest":{"method":"PATCH","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"3642"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"fe01b218-e5d1-4267-810e-e02bfa68633d","name":"Server Error","originalRequest":{"method":"PATCH","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"workspaceName\": \"string\",\n \"seatsLimit\": {\n \"value\": 9730\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"3642"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1c043909-b95d-4ddb-8387-44ec9102eaf0"}],"id":"8ade544b-5630-486e-9f4c-27621dd96a4a","_postman_id":"8ade544b-5630-486e-9f4c-27621dd96a4a","description":""},{"name":"Workspace Users","item":[{"name":"GetAllUsers","id":"3b72abe1-70ff-439d-8568-e7dae78df252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users","description":"

Get all existing and invited users in your organization. Filter by role and invitation status.

\n","urlObject":{"path":["api","public","management","organizations","users"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"f5b6ae61-e8bd-4cd0-b95f-fc35495bcea6","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": 3087,\n \"items\": [\n {\n \"userDetails\": {\n \"userId\": 5043,\n \"name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\",\n \"string\"\n ]\n },\n \"userInvitation\": {\n \"invitationId\": 1790,\n \"invitationStatus\": \"Unknown\",\n \"invitationUrl\": \"string\",\n \"expirationTime\": \"2004-02-14T23:23:22.645Z\"\n },\n \"organizationPermissions\": {\n \"userDeactivate\": false,\n \"manageWorkspace\": false,\n \"manageWorkspaceMembers\": false,\n \"viewBilling\": false,\n \"manageBlling\": false,\n \"manageBillingDetails\": false,\n \"accessBillingInvoiceHistoy\": false\n },\n \"workspacesPermissions\": [\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 6948,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n },\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 386,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n }\n ]\n },\n {\n \"userDetails\": {\n \"userId\": 1372,\n \"name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\",\n \"string\"\n ]\n },\n \"userInvitation\": {\n \"invitationId\": 7457,\n \"invitationStatus\": \"Expired\",\n \"invitationUrl\": \"string\",\n \"expirationTime\": \"1987-09-28T15:34:16.821Z\"\n },\n \"organizationPermissions\": {\n \"userDeactivate\": false,\n \"manageWorkspace\": false,\n \"manageWorkspaceMembers\": false,\n \"viewBilling\": false,\n \"manageBlling\": false,\n \"manageBillingDetails\": false,\n \"accessBillingInvoiceHistoy\": false\n },\n \"workspacesPermissions\": [\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 5476,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n },\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 1662,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n }\n ]\n }\n ]\n}"},{"id":"31db121e-82ad-4a05-9125-cb10da88a1bc","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"bdb2a755-7dc1-4382-b015-9adfef275f71","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"c89e8046-1b06-4a51-ab10-b9d97a47af49","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"7ca2b5d0-8497-4717-9fa2-d7e259d0d31b","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3b72abe1-70ff-439d-8568-e7dae78df252"},{"name":"InviteAdmins","id":"364ac45c-9878-4fed-8749-974adc469185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins","description":"

Invite one or multiple users as admins in your organization. The invitation emails will not be sent, only an invitation URL is generated. You can send this URL to the relevant user in order to register them to HeyReach.

\n","urlObject":{"path":["api","public","management","organizations","users","invite","admins"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"9dbe4e9a-593f-481c-8a2e-3a0f5e7b15de","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"errorCode\": \"WorkspaceDoesNotExists\",\n \"errorMessage\": \"string\",\n \"invitationId\": 5337,\n \"invitationStatus\": \"Unknown\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"1963-11-08T00:06:36.607Z\",\n \"emailAddress\": \"string\"\n },\n {\n \"success\": true,\n \"errorCode\": \"MemberExistsAsAdmin\",\n \"errorMessage\": \"string\",\n \"invitationId\": 4677,\n \"invitationStatus\": \"Unknown\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"1993-11-23T11:25:45.256Z\",\n \"emailAddress\": \"string\"\n }\n]"},{"id":"8f5522df-867d-4e63-8f2d-21ba1f46cc4b","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"6a4e42c6-e85f-4b8b-8289-f8bc61406eab","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"bee7f8bd-45d7-4f0f-806d-bd7a76076375","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"d1accfd9-a65d-4869-8685-8826f94fbc2c","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"tLAFGLB@fSaRWLZVXcdVaLklwbvnAC.bnc\",\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/admins"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"364ac45c-9878-4fed-8749-974adc469185"},{"name":"InviteMembers","id":"1adc402f-718a-4ac6-a660-d66b6d4200b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members","description":"

Invite one or multiple users in your organization. Specify the relevant permissions for each invited user. The invitation emails will not be sent, only an invitation URL is generated. You can send this URL to the relevant user in order to register them to HeyReach.

\n","urlObject":{"path":["api","public","management","organizations","users","invite","members"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"13b1ac38-cafe-4e10-b002-c10896f3e293","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"workspaces\": [\n {\n \"workspaceId\": 5937,\n \"success\": true,\n \"errorCode\": \"Success\",\n \"errorMessage\": \"string\"\n },\n {\n \"workspaceId\": 2957,\n \"success\": true,\n \"errorCode\": \"UnknownError\",\n \"errorMessage\": \"string\"\n }\n ],\n \"invitationId\": 7510,\n \"invitationStatus\": \"Pending\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"2011-12-31T22:55:45.978Z\",\n \"emailAddress\": \"string\"\n },\n {\n \"workspaces\": [\n {\n \"workspaceId\": 9214,\n \"success\": true,\n \"errorCode\": \"UnknownError\",\n \"errorMessage\": \"string\"\n },\n {\n \"workspaceId\": 1177,\n \"success\": false,\n \"errorCode\": \"WorkspaceDoesNotExists\",\n \"errorMessage\": \"string\"\n }\n ],\n \"invitationId\": 8662,\n \"invitationStatus\": \"Revoked\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"1947-11-19T13:31:07.591Z\",\n \"emailAddress\": \"string\"\n }\n]"},{"id":"d0491c41-16da-4020-9757-2fb740da863a","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"6f4ae6c5-2911-4e16-bf6b-5acc27949d56","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"5bff45e5-280c-4a4c-a5a1-286acfa0804b","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"c34b3c62-481b-4d70-8943-bdddef70ab3a","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"pQswPC@kZCGIUBOEKCZxNQjhScp.jef\",\n \"workspaceIds\": [\n 8731,\n 1166\n ],\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"emails\": [\n \"string\",\n \"string\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/members"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1adc402f-718a-4ac6-a660-d66b6d4200b0"},{"name":"InviteManagers","id":"a739f933-0f9d-4b0c-8199-675bf1b0f553","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers","description":"

Invite one or multiple users as managers in your organization. Manager users are special kind of users that exist outside your organization and are invited to specific workspaces. These users will not be part of you organization and only have access to the specified workspaces. These users are automatically added to your workspace and don't need to register.

\n","urlObject":{"path":["api","public","management","organizations","users","invite","managers"],"host":["https://api.heyreach.io"],"query":[],"variable":[]}},"response":[{"id":"88c2dc01-05bd-4c38-bb38-53434af862e0","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"workspaces\": [\n {\n \"workspaceId\": 5937,\n \"success\": true,\n \"errorCode\": \"Success\",\n \"errorMessage\": \"string\"\n },\n {\n \"workspaceId\": 2957,\n \"success\": true,\n \"errorCode\": \"UnknownError\",\n \"errorMessage\": \"string\"\n }\n ],\n \"invitationId\": 7510,\n \"invitationStatus\": \"Pending\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"2011-12-31T22:55:45.978Z\",\n \"emailAddress\": \"string\"\n },\n {\n \"workspaces\": [\n {\n \"workspaceId\": 9214,\n \"success\": true,\n \"errorCode\": \"UnknownError\",\n \"errorMessage\": \"string\"\n },\n {\n \"workspaceId\": 1177,\n \"success\": false,\n \"errorCode\": \"WorkspaceDoesNotExists\",\n \"errorMessage\": \"string\"\n }\n ],\n \"invitationId\": 8662,\n \"invitationStatus\": \"Revoked\",\n \"invitationUrl\": \"string\",\n \"invitationExpirationTime\": \"1947-11-19T13:31:07.591Z\",\n \"emailAddress\": \"string\"\n }\n]"},{"id":"f2e47976-6268-4865-b381-285eb7a108f5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"ef31fb79-9d1f-404c-9716-d1a67d7edc58","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"d8021b79-cfce-4641-84dc-e9c6fecc087d","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"3679a10f-0feb-483f-b876-764150c13815","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inviterEmail\": \"nzLa4CYTiLt@yXST.ltrp\",\n \"emails\": [\n \"string\",\n \"string\"\n ],\n \"workspaceIds\": [\n 6519,\n 3651\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/invite/managers"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a739f933-0f9d-4b0c-8199-675bf1b0f553"},{"name":"GetUserById","id":"97ce3aa1-2a3e-4a3c-bfaf-d672acc9153d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Accept","value":"text/plain"}],"url":"https://api.heyreach.io/api/public/management/organizations/users/:userId","description":"

Get information about a given user.

\n","urlObject":{"path":["api","public","management","organizations","users",":userId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"type":"any","value":"5421","key":"userId"}]}},"response":[{"id":"71a27c5f-7b81-4cc6-8096-aa6bfcc1661c","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/:userId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users",":userId"],"variable":[{"key":"userId","value":"5421"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"userDetails\": {\n \"userId\": 1846,\n \"name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\",\n \"string\"\n ]\n },\n \"organizationPermissions\": {\n \"userDeactivate\": false,\n \"manageWorkspace\": false,\n \"manageWorkspaceMembers\": false,\n \"viewBilling\": false,\n \"manageBlling\": false,\n \"manageBillingDetails\": false,\n \"accessBillingInvoiceHistoy\": false\n },\n \"workspacesPermissions\": [\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 8053,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n },\n {\n \"workspaceName\": \"string\",\n \"workspaceId\": 781,\n \"permissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n }\n }\n ]\n}"},{"id":"037b3965-4851-4ad3-94a9-fed82cb9f65a","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/:userId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users",":userId"],"variable":[{"key":"userId","value":"5421"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"c01f5f82-aaee-4c91-8309-35ce64e652ad","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/:userId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users",":userId"],"variable":[{"key":"userId","value":"5421"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"5045add7-b56d-43fb-86e4-f23cd28f8e5b","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/:userId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users",":userId"],"variable":[{"key":"userId","value":"5421"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"d8efde19-aa7e-431c-9777-b5387f5b9565","name":"Server Error","originalRequest":{"method":"GET","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""}],"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/:userId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users",":userId"],"variable":[{"key":"userId","value":"5421"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"97ce3aa1-2a3e-4a3c-bfaf-d672acc9153d"},{"name":"GetWorkspaceUsers","id":"3375634b-82ec-4f51-8658-b4dc40674b5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

Workspace API Key

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","description":"

Get all users in a given workspace along with their role and permissions.

\n","urlObject":{"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"host":["https://api.heyreach.io"],"query":[],"variable":[{"type":"any","value":"5421","key":"workspaceId"}]}},"response":[{"id":"3dd45b62-93d1-41c4-b091-d9aefdf4c5dc","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": 1040,\n \"items\": [\n {\n \"workspaceId\": 9178,\n \"organizationPermissions\": {\n \"userDeactivate\": false,\n \"manageWorkspace\": false,\n \"manageWorkspaceMembers\": false,\n \"viewBilling\": false,\n \"manageBlling\": false,\n \"manageBillingDetails\": false,\n \"accessBillingInvoiceHistoy\": false\n },\n \"workspacePermissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"userDetails\": {\n \"userId\": 5497,\n \"name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\",\n \"string\"\n ]\n },\n \"userInvitation\": {\n \"invitationId\": 1916,\n \"invitationStatus\": \"Accepted\",\n \"invitationUrl\": \"string\",\n \"expirationTime\": \"2011-01-09T19:33:34.216Z\"\n }\n },\n {\n \"workspaceId\": 7874,\n \"organizationPermissions\": {\n \"userDeactivate\": false,\n \"manageWorkspace\": false,\n \"manageWorkspaceMembers\": false,\n \"viewBilling\": false,\n \"manageBlling\": false,\n \"manageBillingDetails\": false,\n \"accessBillingInvoiceHistoy\": false\n },\n \"workspacePermissions\": {\n \"viewLinkedInSenders\": false,\n \"manageLinkedInSendersSettings\": false,\n \"viewLeadLists\": false,\n \"importEditManageLeadLists\": false,\n \"viewMyNetwork\": false,\n \"viewCampaigns\": false,\n \"editManageCampaigns\": false,\n \"viewLinkedInSenderInboxes\": false,\n \"replyFromLinkedInSenderInboxes\": false,\n \"viewIntegrations\": false,\n \"manageIntegrations\": false,\n \"exportDataToCRMs\": false,\n \"viewNotifications\": false,\n \"manageNotifications\": false\n },\n \"userDetails\": {\n \"userId\": 8221,\n \"name\": \"string\",\n \"surname\": \"string\",\n \"email\": \"string\",\n \"roles\": [\n \"string\",\n \"string\"\n ]\n },\n \"userInvitation\": {\n \"invitationId\": 5704,\n \"invitationStatus\": \"Pending\",\n \"invitationUrl\": \"string\",\n \"expirationTime\": \"2006-06-07T07:59:17.346Z\"\n }\n }\n ]\n}"},{"id":"13b903c7-a5e4-43db-a9b1-718206ec077a","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"dba8d6ef-083c-47ef-8a56-859c0e1723c7","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"04a37c9a-8028-440f-abeb-6bcd8faccac7","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 7923,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"},{"id":"237f2b9a-333a-43d6-9137-bda9f643fa69","name":"Server Error","originalRequest":{"method":"POST","header":[{"description":"Workspace API Key","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"offset\": 895,\n \"role\": \"Admin\",\n \"invitationStatus\": [\n \"Accepted\",\n \"Pending\"\n ],\n \"limit\": 38\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.heyreach.io/api/public/management/organizations/users/workspaces/:workspaceId","host":["https://api.heyreach.io"],"path":["api","public","management","organizations","users","workspaces",":workspaceId"],"variable":[{"key":"workspaceId","value":"5421"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3375634b-82ec-4f51-8658-b4dc40674b5f"}],"id":"e9f84421-4828-408b-aac0-0dd354b8e70f","_postman_id":"e9f84421-4828-408b-aac0-0dd354b8e70f","description":""}],"id":"cb3c8dd3-72af-412e-93a8-0ccfa40c2068","description":"

Organization Management API

\n

This HeyReach API allows you to manage workspaces, users, permissions and other API/Integration Keys in your organization. This API has the highest access privileges so access is only available for organization Admins.

\n

Finding your Organization API key

\n

Authentication is done same as the regular HeyReach API, using the X-API-KEYHeader. The only difference is that these methods require the Organization API Key which can be found in your Orgainzation settings.
The API key is used to authenticate the incoming requests and map them to your organization.
These API keys never expire, however they can be deleted/deactivated/rolled-over.

\n

Rate Limits

\n

The Organization API has a separate rate limit of 300 requests per minute. This limit is separate from the regular API.
Going above the limit will return a 429 HTTP status code and an error.

\n","_postman_id":"cb3c8dd3-72af-412e-93a8-0ccfa40c2068"}],"variable":[{"key":"baseUrl","value":"/"}]}