Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API Explorer API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Topics

Introduction
Authentication

Endpoints

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 Execution Steps
- Stop an automation step POST
- Start an automation step POST
Automation Executions
- Get all automation executions for an automation blueprint GET
- Get an automation execution GET
Bank Accounts
Beneficiary
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-Find Submission
Fact-Finds
File Uploading
Filesystem
Firms
Form Builder
Goals (v1)
Goals (v2)
Groups
Holdings
Illustrations
Imports
Income (v1)
Income (v2)
Income Reconciliation
Introducer
Letter of Authority
- Generate Letter of Authority POST
Logins
Logs
Lookups
Mailboxes
Miscellaneous
- Get the application's state. GET
Model
Model Types
- Custom field models GET
- Time trackable models GET
Mortgage Searches (v2)
Mortgage Sourcing
- Determine if the authenticated account can use the MortgageBrain addon for sourcing. GET
- Create a mortgage search with the Mortgage Brain provider POST
Navigation
- Return the data needed to build up the URL for front end for a given model and UUID. GET
Networth
- Get net worth GET
- Get net worth line graph GET
New Business Events
Notes
Notifications
OAuth2 Connections (External Only)
Plan Returns
- Calculate returns for a plan within a date range GET
Plans
Plans (v2)
- Get all plans GET
- Get line graph of plans valuations GET
Platform
- Show Platform Detail GET
- Get all models for a supported platform. GET
Premiums
Providers
- List all providers GET
- Get an individual provider GET
Reactions
- Create a reaction POST
- Delete a reaction DELETE
Report Templates
Report Types
- Get all Report Types GET
Reports
Risks (v1)
Risks (v2)
Roles (v2)
Search
- Typesense multi searching GET
- Postcode Searching POST
Shareholders
Staff Members
Statements
Static Data
Sub Account Portfolios
Sub Accounts
Tagging
Task Statuses
Tasks
Time Entries
Transaction
Transactions (v2)
- Get all transactions GET
Unipass Certificates
User Management
Valuations
Valuations (V2)
- Bulk insert valuations POST
Webhook Subscriptions
Withdrawals
Workflows

Powered by Bump.sh

API Explorer API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Roles (v2)

Ask AI

Open in ChatGPT
Open in Claude

View as Markdown
Copy as Markdown

APIs for managing roles within PlannrCRM