# Get a campaign's Warm-up board

`GET https://api.tryscouty.com/v1/campaigns/{campaignId}/warmup`

Reads the Warm-up board for one campaign: how many accepted creators are at each stage (needs setup, Launchpoint pending, account pending, warm-up 1, warm-up 2, ready to post, blocked), how many need attention, how many are not ready, and, given a date, how many are due to be ready by then and are not. A token without creators:read gets the counts only.

- Scope: `campaigns:read`
- Kind: read
- MCP tool: `scouty_get_warmup_board`

## Authorization

Send `Authorization: Bearer $SCOUTY_TOKEN`. The token needs the `campaigns:read` scope.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `campaignId` | `integer` | Required | The campaign's id. |

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `by` | `string` | Optional | A date, YYYY-MM-DD: dueBy counts the creators due to be ready by then who are not. |

## Request

### cURL

```bash
curl -s "https://api.tryscouty.com/v1/campaigns/42/warmup?by=2026-10-09" \
  -H "Authorization: Bearer $SCOUTY_TOKEN"
```

### JavaScript

```js
const response = await fetch("https://api.tryscouty.com/v1/campaigns/42/warmup?by=2026-10-09", {
  headers: {
    Authorization: `Bearer ${process.env.SCOUTY_TOKEN}`,
  },
});
console.log(await response.json());
```

### Python

```python
import os

import requests

token = os.environ["SCOUTY_TOKEN"]
response = requests.get(
    "https://api.tryscouty.com/v1/campaigns/42/warmup",
    headers={"Authorization": f"Bearer {token}"},
    params={"by": "2026-10-09"},
)
print(response.json())
```

## Responses

### 200 OK

```json
{
  "campaignId": 42,
  "warmup": true,
  "columns": {
    "needsSetup": 1,
    "launchpointPending": 2,
    "accountPending": 1,
    "warmup1": 3,
    "warmup2": 1,
    "readyToPost": 4,
    "blocked": 1
  },
  "needsAttention": 2,
  "notReady": 9,
  "dueBy": 5,
  "left": 0,
  "creators": [
    {
      "memberId": 7,
      "name": "Sample Creator",
      "column": "accountPending",
      "needsAttention": false,
      "nextAction": {
        "who": "creator",
        "text": "Send the account username"
      },
      "blocker": null,
      "readyBy": "2026-10-09"
    }
  ]
}
```

### 400 Bad Request

```json
{
  "error": {
    "code": "invalid_request",
    "message": "Those arguments are not the shape this capability takes: by."
  }
}
```

### 401 Unauthorized

```json
{
  "error": {
    "code": "missing_token",
    "message": "This API needs an Authorization header carrying a bearer token."
  }
}
```

### 403 Forbidden

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not carry the campaigns:read scope. Ask the team for one that does."
  }
}
```

### 404 Not Found

```json
{
  "error": {
    "code": "not_found",
    "message": "No such campaign."
  }
}
```

### 429 Too Many Requests

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait for the current minute to end."
  }
}
```

## Errors

| Status | `error.code` | Meaning |
|---|---|---|
| 400 Bad Request | `invalid_request` | The request was not the shape this capability takes, or its body was not JSON. |
| 401 Unauthorized | `missing_token`, `invalid_token`, `token_revoked`, `token_expired`, `token_orphaned` | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | `insufficient_scope`, `wrong_principal` | The token does not carry the scope this capability needs. |
| 404 Not Found | `not_found` | No such route, or no such campaign for this client. |
| 429 Too Many Requests | `rate_limited` | Too many requests this minute. Retry-After says how long is left. |

Full reference: https://docs.tryscouty.com/reference