GetAll | HeyReach API Documentation

curl -X POST https://api/api/public/campaign/GetAll \
     -H "X-API-KEY: {{HR_API_KEY}}" \
     -H "Content-Type: application/json" \
     -d '{
  "offset": 0,
  "keyword": "my campaign name",
  "statuses": [
    "DRAFT",
    "IN_PROGRESS",
    "PAUSED",
    "FINISHED",
    "CANCELED",
    "FAILED",
    "STARTING",
    "SCHEDULED"
  ],
  "accountIds": [
    123,
    2,
    5
  ],
  "limit": 10
}'

{
  "totalCount": "<integer>",
  "items": [
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    },
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    }
  ]
}

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

Request

This endpoint expects an object.

offsetintegerRequired

keywordstringRequired

statuseslist of stringsRequired

accountIdslist of integersRequired

limitintegerRequired

Response

totalCountstring

itemslist of objects

Errors

401

Get All Campaigns Request Unauthorized Error

404

Get All Campaigns Request Not Found Error

429

Get All Campaigns Request Too Many Requests Error

Headers

Request

Response

Errors