API Reference
The CheckFlow REST API allows you to interact with your checklists, tasks, templates, and team members programmatically. All requests and responses use JSON.
Base URL
https://app.checkflow.io
Authentication
All API requests must include your API key in a request header:
X-API-KEY: your-api-key-here
If the X-API-KEY header is missing or invalid, the API will return a 401 Unauthorized response.
Generating an API Key
Only team Administrators can generate an API key. Go to the Team Management page and click Generate API Key.
API Versioning
The API supports versioning via the X-API-VERSION request header. The current version is 2.0. Some endpoints are only available in version 2.0 — this is noted in the relevant endpoint documentation.
X-API-VERSION: 2.0
Interactive Documentation
You can explore and test all API endpoints interactively using the built-in Swagger UI:
https://app.checkflow.io/swagger
Response Codes
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad Request — a required parameter is missing or invalid |
401 | Unauthorized — the API key is missing or invalid |
404 | Not Found — the requested resource could not be found |
Endpoint Groups
| Group | Description |
|---|---|
| Authentication | Validate your API key |
| Checklists | Create, retrieve, and delete checklists |
| Tasks | Retrieve, update, and assign tasks |
| Templates | Retrieve templates and their task structure |
| Team | Retrieve team members and groups |
| Tags | Create, delete, and assign tags |
| Analytics | Retrieve analytical data |
| Webhooks | Manage webhook subscriptions |