CheckPilot
v1.0 · Stable

CheckPilot API Reference

REST API over HTTPS. JSON in, JSON out. All endpoints require authentication and respect workspace scoping.

Base URL
api.checkpilot.io
Format
application/json
Auth
Bearer token

Quick start

Every request must include a bearer token. Tokens are scoped to a workspace and a role.

curl https://api.checkpilot.io/v1/checklists \
  -H "Authorization: Bearer cp_live_xxx" \
  -H "Accept-Language: en"

Example response

{
  "data": [
    {
      "id": "cl_a1b2c3",
      "title": "Pre-Trip Vehicle Inspection",
      "type": "Safety",
      "status": "active",
      "items": [
        { "id": "i1", "text": "Tires inflated", "type": "checkbox", "required": true }
      ],
      "created_at": "2026-04-01T08:00:00Z"
    }
  ],
  "meta": { "total": 12, "page": 1 }
}

Authentication

OAuth 2.0 with workspace-scoped tokens.

POST
/v1/auth/tokenExchange credentials for a bearer token.
POST
/v1/auth/refreshRefresh an expiring token.
POST
/v1/auth/revokeRevoke a session.

Checklists

Define checklist templates with typed items.

GET
/v1/checklistsList checklists in your workspace.
POST
/v1/checklistsCreate a new checklist.
GET
/v1/checklists/{id}Retrieve a single checklist.
PATCH
/v1/checklists/{id}Update items, status, or metadata.
DELETE
/v1/checklists/{id}Archive a checklist.

Assignments

Assign work to users and track completion.

GET
/v1/assignmentsList assignments, filterable by user/status.
POST
/v1/assignmentsAssign a checklist to one or more users.
POST
/v1/assignments/{id}/submitSubmit responses and complete.
GET
/v1/assignments/{id}/pdfDownload a PDF of the completed assignment.

Users & Companies

Manage members, roles, and tenants.

GET
/v1/usersList members of your workspace.
POST
/v1/usersInvite a new member.
PATCH
/v1/users/{id}Update profile or role.
GET
/v1/companies[Super Admin] List all companies.

Billing

Subscription and invoicing.

GET
/v1/billing/subscriptionGet current plan and seat count.
POST
/v1/billing/checkoutCreate a checkout session.
POST
/v1/billing/portalGenerate a customer portal link.