Planner API Overview

The Planner API provides programmatic access to projects, schedules, and activities. It is a REST API returning JSON.

Note: Full API documentation and interactive explorer are published at https://api.kazinex.com/planner/docs. This page is a quick-reference summary.

Base URL

https://api.kazinex.com/planner/v1

Authentication

All requests must include a bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

Generate an API key in Account settings → API keys → Create new key. Keys can be scoped to read-only or read-write. Store your key securely — it is shown only once at creation.

Rate limits

Plan	Requests / minute	Requests / day
Professional	120	10 000
Business	600	100 000
Enterprise	Custom	Custom

Endpoint groups

Group	Base path	Description
Projects	/projects	List, create, update, delete projects
Schedules	/projects/{id}/schedules	Upload XER/XML, list revisions
Activities	/projects/{id}/activities	Read and update activity data
Baselines	/projects/{id}/baselines	Manage baseline assignments
Quality	/projects/{id}/quality	Retrieve quality scores and check results
Resources	/projects/{id}/resources	Resource assignments and loading data
Users	/users	Team members and roles (admin only)
Webhooks	/webhooks	Register event webhooks

Example request

List all projects for the authenticated user:

GET https://api.kazinex.com/planner/v1/projects
Authorization: Bearer <your-api-key>
Accept: application/json

Example response (truncated):

{
  "data": [
    {
      "id": "proj_01HZ4G",
      "name": "North Harbour Civil Works",
      "created_at": "2025-01-14T08:00:00Z",
      "schedule_count": 5
    }
  ],
  "meta": { "total": 1, "page": 1 }
}

Webhooks

Register a webhook to receive events when schedules are uploaded, baselines are marked, or quality checks complete:

POST /webhooks
{
  "url": "https://your-system.example.com/hook",
  "events": ["schedule.uploaded", "baseline.marked", "quality.complete"]
}

SDK support

Official SDKs for TypeScript/Node.js and Python are available on the Kazinex developer portal. Community SDKs for other languages may be available via third-party contributors.