Overview

The Dynamic Planner Open API enables secure, standards-based access to platform data such as CRM, profiling, finances and real‑time events. This guide provides the essential steps to begin integrating with the API, from onboarding to your first authenticated request.

All Dynamic Planner APIs use OAuth 2.0, structured error envelopes, diagnostic trace headers and versioned REST endpoints for a consistent and predictable developer experience.

Request API Access

Before you can authenticate or call any API, your organisation must be onboarded and issued the appropriate credentials.

To begin the onboarding process, visit Get API Access. This page explains what information you need to provide and how your credentials will be issued.

Once your access has been approved, return here to follow the steps for authentication and making your first API request.

Authentication Overview

All Dynamic Planner APIs use OAuth 2.0. In practice, your integration will use one of our supported access models, each built on top of either the Client Credentials Flow or the Hybrid Flow. The full details are available in the Authentication & Access guide.

At a high level, the platform supports three operational models:

• Fully Automated (Service Account) — machine-to-machine integrations using the Client Credentials Flow; best for backend and high‑volume automation.
• User‑Present API Access — adviser or employee is actively logged in; permissions follow their Organisation Unit (OU); uses the Hybrid Flow.
• User‑Based Automation (Time‑Bound Delegation) — a user authorises access once, enabling background or scheduled processing for a defined period.

Regardless of the model, authentication results in an access_token which must be sent in the Authorization header when calling API endpoints.