---
title: "Refresh health grades"
method: POST
path: "/lists/{id}/health"
tags: ["Lists"]
---

# Refresh health grades

`POST /lists/{id}/health`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/lists/{id}/health`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Queues health scoring for companies not scored in the last 7 days (`?refresh=true` for all).

## Path parameters

- `id` integer, required

## Query parameters

- `refresh` boolean

## Response `200`

Already up to date

## Other responses

- `202`: Queued
- `401`: API key missing, malformed or revoked
- `403`: The key's plan does not include this endpoint (`code: plan_upgrade_required`, with `upgrade_url`), the key may not call it, or the key is beyond the plan's key limit after a downgrade (`code: key_limit_exceeded`: the newest keys are paused until keys are deleted or the plan upgraded)
- `429`: Fair use (`code: fair_use_limit`): forced health score refreshes (refresh=true) are limited to 5 an hour and 20 a day for each account. A refused call is not counted; `Retry-After` says when to try again. A 429 with `code: rate_limited` is the request quota.

---

[API](https://skmtc.dev/companystack/apis/companystack-api.md) · [All operations](https://skmtc.dev/companystack/apis/companystack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/companystack/apis/companystack-api/revisions/8f3234237d2d?raw)