Skip to content

Be first in. Get early access

PeriodGuard

All documentation

API keys

An API key lets a script, a spreadsheet or an AI agent read your change history without a browser. Keys are created and revoked on API keys. Free allows 1 active key, Business 3, Practice 5 and Practice 50 10. A key can read every business on the account, so give it only to tools you trust.

Creating a key

  1. Open Account → API keys and press Create key.
  2. Give it a name you will recognise later, such as "CI" or "Claude Desktop".
  3. Copy the key now. It is shown once; afterwards only its first characters (periodguard_live_3f9c…) are visible.

Keys starting with periodguard_test_ come from a test deployment and only work there.

Using a key

Send it as a bearer token:

curl https://periodguard.com/api/v1/changes \
  -H "Authorization: Bearer periodguard_live_…" \
  -H "Content-Type: application/json" \
  -d '{"closedOnly": true, "limit": 20}'

X-API-Key: <key> works as well. Every successful call counts one result against the account's monthly allowance, the same allowance the web app uses. The response's usage object tells you how many results remain.

Rate limits

60 requests per minute per key by default. The X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers are on every response; a 429 includes Retry-After in seconds.

Revoking a key

Press Revoke next to the key. Requests with a revoked key get HTTP 401 immediately. Revoke and recreate a key if it was ever pasted somewhere public.

Errors

Every error is JSON: {"error": {"code": "...", "message": "..."}}. Codes: unauthorized (401), invalid_input (400, with details), payment_required (402, allowance used up), rate_limited (429), internal (500, retry with backoff).