GetById | HeyReach API Documentation

{
  "id": 274079,
  "name": "My First Campaign",
  "creationTime": "2025-12-01T08:06:15Z",
  "linkedInUserListName": "LinkedIn Ad BF Leads",
  "linkedInUserListId": 123456,
  "campaignAccountIds": [
    113298
  ],
  "status": "IN_PROGRESS",
  "progressStats": {
    "totalUsers": 9,
    "totalUsersInProgress": 8,
    "totalUsersPending": 0,
    "totalUsersFinished": 1,
    "totalUsersFailed": 0,
    "totalUsersManuallyStopped": 0,
    "totalUsersExcluded": 0
  },
  "excludeInOtherCampaigns": false,
  "excludeHasOtherAccConversations": false,
  "excludeContactedFromSenderInOtherCampaign": false,
  "organizationUnitId": 12345
}

Get a Campaign by id

Query parameters

campaignIdstringOptional

(Required)

Response

idinteger

namestring

creationTimedatetime

linkedInUserListNamestring

linkedInUserListIdinteger

campaignAccountIdslist of integers

statusstring

progressStatsobject

excludeInOtherCampaignsboolean

excludeHasOtherAccConversationsboolean

excludeContactedFromSenderInOtherCampaignboolean

organizationUnitIdinteger

excludeListIdany or nullOptional

Errors

401

Get by ID Campaigns Request Unauthorized Error

404

Get by ID Campaigns Request Not Found Error

429

Get by ID Campaigns Request Too Many Requests Error

Headers

Query parameters

Response

Errors