Documentation

How to make the thread hold

Implementation playbooks for each layer, plus a full API reference. Written for the person doing the rollout rather than for the person approving it.

Browse

Documentation by layer

Import your objectives and project register, connect identity, and issue the first agreements.

Scorecard perspectives, goal types, weights, cycles and SMART validation rules.

Portfolio structure, baselines, stage gate configuration and the risk register.

Agreement templates, target references, review cycles and calibration sessions.

Every object, with authentication, pagination, filtering and rate limits documented.

Event catalogue, payload shapes, retry behaviour and signature verification.

SAML, OIDC, SCIM provisioning, permission sets and matrix reporting lines.

Warehouse sync, bulk export formats, retention rules and residency options.

API

The whole point of the API is the linkage. These four are where most integrations start.

api.teampulse.app

POST/v1/goalsCreate an objective with a perspective and weight

GET/v1/portfolios/:id/rollupBudget, schedule and cost variance for a portfolio

POST/v1/agreements/:id/targetsAttach a target referencing a goal or KPI

GET/v1/projects?goal_id=Every project serving a given objective

Tell us which page you were on and what you expected to find. We treat that as a bug.