API Docs

Proofwork provides a full REST API. Every feature available in the app is also available programmatically.

Quick links

• API Reference — full endpoint table, auth, curl examples
• OpenAPI Spec — canonical OpenAPI 3.0.3 JSON
• Scalar UI — interactive API docs

Getting started

1. Sign up at app.proofwork.today
2. Go to Settings → API Keys and generate a key
3. Use the Bearer token in your Authorization header
4. Base URL: https://app.proofwork.today/api/v1

What you can do with the API

• Manage field work — create workflows, attach requirements, track completion
• Track inventory — create things, log usage, monitor stock levels
• Query events — filter by type, date, worker, or workflow
• Manage users — create workers, update roles, archive inactive accounts
• Build integrations — webhooks for workflow completion, event creation, inventory changes

Authentication

All requests use Bearer token auth:

Authorization: Bearer pw_your_api_key

Tokens are generated in the app dashboard. They’re shown once — save them securely. Hashed at rest; cannot be recovered.

Webhooks

Proofwork fires webhooks for key events:

Event	Trigger
workflow.completed	All requirements met
event.created	New event captured
thing.updated	Inventory change

Configure webhook URLs in Settings → Webhooks from the app.