---
title: "Run now and return the digest"
method: POST
path: "/api/v1/pulse/{sub_id}/run"
tags: ["Pulse"]
---

# Run now and return the digest

`POST /api/v1/pulse/{sub_id}/run`

## Request

- Base URL: `https://data.useplinth.com`
- URL: `https://data.useplinth.com/api/v1/pulse/{sub_id}/run`
- Auth: API key in header `X-API-Key`

Runs the checks synchronously and returns the digest. The first run is a baseline: it records what is on file today and reports changes from the next run on. `checks` narrows the run; `format=html|pdf` renders it.

## Path parameters

- `sub_id` string, required

## Query parameters

- `checks` string, nullable: Narrow the run to these checks, comma-separated: compliance, filings, grants, gov, people, web. Omit for the subscription's full set.
- `format` 'json' | 'xml', nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `401`: No API key, or a key we do not recognize.
- `402`: The call allowance is spent, the account is inactive, or the endpoint needs a paid plan — the message says which, and names the period it resets on (daily on free and non-profit plans, monthly on Pro).
- `422`: Validation Error

---

[API](https://skmtc.dev/useplinth/apis/plinth-grants-api.md) · [All operations](https://skmtc.dev/useplinth/apis/plinth-grants-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useplinth/apis/plinth-grants-api/revisions/15273cd72ecf?raw)
