Get all campaigns

v1.0.0

Return a paginated list of HeyReach campaigns, optionally filtered by name, status, or LinkedIn account.

Input

{
  "type": "object",
  "properties": {
    "offset": {
      "type": "integer",
      "description": "Number of campaigns to skip."
    },
    "limit": {
      "type": "integer",
      "description": "Page size (1–100)."
    },
    "keyword": {
      "type": "string",
      "description": "Filter campaigns by name."
    },
    "statuses": {
      "type": "array",
      "description": "Filter by campaign status.",
      "items": {
        "type": "string",
        "enum": [
          "DRAFT",
          "IN_PROGRESS",
          "PAUSED",
          "FINISHED",
          "CANCELED",
          "FAILED"
        ]
      }
    },
    "accountIds": {
      "type": "array",
      "description": "Filter by LinkedIn sender account IDs.",
      "items": {
        "type": "integer"
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "totalCount": {
      "type": "integer"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}