Quickstart

Make your first jeCheck API call in under five minutes. You need a jeCheck company on the Enterprise plan and a user who may manage API keys (administrators can).

1. Create an API key#

1. Sign in to jeCheck and open API & MCP (the user menu or Management → API & MCP).
2. Click New key, name it after the system that will use it (e.g. Data warehouse).
3. Choose what the key may do:
   • Roles — the key gets exactly the permissions of the selected roles (you can only grant what you have yourself);
   • Locations — all locations or a selected subset;
   • Access — Read or Read & write;
   • optional expiry date.
4. Copy the token. It starts with jck_live_ and is shown only once.

Tip Developers who just want to experiment can create a personal token in API & MCP → My tokens. It acts with your own permissions.

2. Check the key#

export JECHECK_TOKEN=jck_live_xxxxxxxxxxxxxxxx

curl https://app.jecheck.io/api/ext/v1/me \
  -H "Authorization: Bearer $JECHECK_TOKEN"

The response tells you who the key acts as, the company, the token scopes and every permission with the locations where it applies:

{
  "data": {
    "user": { "id": 1042, "name": "API: Data warehouse", "is_service": true },
    "company": { "id": 761, "name": "Coffee Lab", "plan": "enterprise" },
    "token": { "kind": "key", "scopes": ["read", "write"] },
    "permissions": { "audits.view": null, "tasks.view_all": [12, 14] }
  }
}

null means all locations; a list means only those location ids.

3. Read data#

Latest failed audits:

curl "https://app.jecheck.io/api/ext/v1/audits?status=failed&period=7d" \
  -H "Authorization: Bearer $JECHECK_TOKEN"

Overdue corrective tasks, most urgent first:

curl "https://app.jecheck.io/api/ext/v1/tasks?overdue=true&sort=due_asc" \
  -H "Authorization: Bearer $JECHECK_TOKEN"

4. Write data#

Create a task (requires a key with Read & write):

curl -X POST https://app.jecheck.io/api/ext/v1/tasks \
  -H "Authorization: Bearer $JECHECK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Replace the broken fridge seal", "priority": "high", "location_id": 12, "due_date": "2026-11-10"}'

Assignees get notified exactly as if the task was created in the app.

5. Next steps#

• Authentication — key types, scopes, rotation.
• Pagination & sync — fetch everything and keep it in sync with updated_since.
• API reference — every endpoint with examples.
• MCP server — connect Claude, ChatGPT or Cursor.
• OpenAPI spec — generate a typed client (openapi-generator, orval, NSwag…).