Topics

Introduction
Authentication

Endpoints

2FA
2FA via SMS
- SMS One-Time Password (OTP) set up request. POST
AML Checks
Account
Actions
- Get all Actions belonging to an account GET
Addon Subscriptions
Addons
Addresses (v1)
Addresses (v2)
Audits
Automation Blocks
- Get all Automation block information that can be used for blueprint steps GET
- Get all trigger types for automation blocks GET
Automation Blueprints
Automation Executions
- Get all automation executions for an automation blueprint GET
- Get an automation execution GET
Bank Accounts
Beneficiary
Billing
Blueprint Steps
Bulk Actions
Business Metrics
Cases
Circles
Claim
Client Statuses
Clients
Cloning
- Clone a model POST
Contact Details (v1)
Contact Details (v2)
Contributions
Conversations
Cover
Custom Default Folders
Custom Fields
Dependants (v1)
Dependants (v2)
Document Builder
Document Packs
Document Signing
Employee
Employment (V2)
Employments
Endpoints
Expenditures
FCA Numbers
Fact-Finds
File Uploading
Filesystem
Firms
Form Builder
Goals (v1)
Goals (v2)
Groups
Holdings
Illustrations
Imports
Income (v1)
Income (v2)
Income Reconciliation
Introducer
Logins
Logs
Lookups
Mailboxes
Miscellaneous
- Get the application's state. GET
Model Types
- Custom field models GET
- Time trackable models GET
Navigation
- Return the data needed to build up the URL for front end for a given model and UUID. GET
Network Management
- Network charges GET
New Business Events
Notes
Notifications
OAuth2 Connections (External Only)
Plans
Platform
- Show Platform Detail GET
- Get all models for a supported platform. GET
Premiums
Providers
- List all providers GET
- Get an individual provider GET
Public Forms
Reactions
- Create a reaction POST
- Delete a reaction DELETE
Report Templates
Report Types
- Get all Report Types GET
Reports
Risks (v1)
Risks (v2)
Search
- Typsense multi searching GET
- Postcode Searching POST
Shareholders
Staff Members
Statements
Static Data
Sub Account Portfolios
Sub Accounts
Tagging
Task Statuses
Tasks
Time Entries
Transaction
Unipass Certificates
User Management
Valuations
Valuations (V2)
- Bulk insert valuations POST
Withdrawals
Workflows

Powered by Bump.sh

API Changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

File Uploading

APIs for managing uploading files to Plannr