> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.heyreach.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server.

# GetById

GET https://api//api/public/campaign/GetById?campaignId=<long>

Get a Campaign by id

Reference: https://docs.heyreach.io/hey-reach-api/campaigns/get-by-id

## Request

### Query parameters

- `campaignId` (string, optional) — (Required)

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

## Response

### 200

OK

- `id` (integer, required)
- `name` (string, required)
- `creationTime` (datetime, required)
- `linkedInUserListName` (string, required)
- `linkedInUserListId` (integer, required)
- `campaignAccountIds` (list of integer, required)
- `status` (string, required)
- `progressStats` (object, required)
  - `totalUsers` (integer, required)
  - `totalUsersInProgress` (integer, required)
  - `totalUsersPending` (integer, required)
  - `totalUsersFinished` (integer, required)
  - `totalUsersFailed` (integer, required)
  - `totalUsersManuallyStopped` (integer, required)
  - `totalUsersExcluded` (integer, required)
- `excludeInOtherCampaigns` (boolean, required)
- `excludeHasOtherAccConversations` (boolean, required)
- `excludeContactedFromSenderInOtherCampaign` (boolean, required)
- `organizationUnitId` (integer, required)
- `excludeListId` (any, optional, nullable)

## Errors

### 401 Get by ID Campaigns Request Unauthorized Error

Unauthorized

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

### 404 Get by ID Campaigns Request Not Found Error

Not Found

- `errorMessage` (string, required)

### 429 Get by ID Campaigns Request Too Many Requests Error

Too Many Requests

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

## Examples

**Response**

```json
{
  "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
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/campaign/GetById"

querystring = {"campaignId":"<long>"}

headers = {"X-API-KEY": "<string>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api//api/public/campaign/GetById?campaignId=%3Clong%3E';
const options = {method: 'GET', headers: {'X-API-KEY': '<string>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api//api/public/campaign/GetById?campaignId=%3Clong%3E"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<string>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api//api/public/campaign/GetById?campaignId=%3Clong%3E")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<string>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api//api/public/campaign/GetById?campaignId=%3Clong%3E")
  .header("X-API-KEY", "<string>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api//api/public/campaign/GetById?campaignId=%3Clong%3E', [
  'headers' => [
    'X-API-KEY' => '<string>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/campaign/GetById?campaignId=%3Clong%3E");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-KEY", "<string>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-KEY": "<string>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/campaign/GetById?campaignId=%3Clong%3E")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```