For AI agents: a documentation index is available at https://apidocs.plannrcrm.com/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

Do not miss any PlannrCRM API changes, ever again

Subscribe to the PlannrCRM API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
2 structure changes including:
2 Modifications
Modified 2
POST /api/v1/leads
  • Body
  • application/json content type Modified
    • source_uuid property Modified
      • Property is no longer required
      • Type went from string(uuid) to string(uuid) | null
PUT /api/v1/leads/{uuid}
  • Body
  • application/json content type Modified
    • source_uuid property Modified
      • Type went from string(uuid) to string(uuid) | null
12 structure changes including:
2 Additions
10 Modifications
Modified 10
DELETE /api/v1/leads/{lead_uuid}/archive
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
DELETE /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
DELETE /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
GET /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
  • Query
  • filter[disqualified], filter[pending_disqualified] query parameters Added
GET /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
POST /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
POST /api/v1/leads/{lead_uuid}/archive
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
POST /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
POST /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
PUT /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_disqualified, is_pending_disqualified, can_promote, can_disqualify, disqualified_by properties Added
Added 2
DELETE /api/v1/leads/{lead_uuid}/disqualify
POST /api/v1/leads/{lead_uuid}/disqualify
1 structure change including:
1 Modification
Modified 1
POST /api/v1/provider-statement/import
  • Body
  • application/json content type Modified
    • parameters property Modified
      • has_headers property Added
274 structure changes including:
1 Addition
273 Modifications
Modified 273
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • author property Modified
        • custom_fields property Modified
      • chargeable property Modified
        • custom_fields property Modified
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • custom_fields property Modified
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retired_at, is_retired, has_data properties Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • custom_fields property Modified
POST /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • custom_fields property Modified
POST /api/v1/conversation/inline
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • custom_fields property Modified
      • participants property Modified
        • custom_fields property Modified
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • custom_fields property Modified
      • participants property Modified
        • custom_fields property Modified
POST /api/v1/client/{client_uuid}/risk
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v1/client/{client_uuid}/goal
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v1/client/{client_uuid}/employment
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/circles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/checklist/{checklist_uuid}/items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • custom_fields property Modified
POST /api/v1/charge-split
  • Response
  • 201 response Modified
    • application/json content type Modified
      • splitable property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
      • accounts property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • linked_owners property Modified
        • custom_fields property Modified
      • linked_plans property Modified
        • custom_fields property Modified
      • cases property Modified
        • custom_fields property Modified
      • wrap property Modified
        • custom_fields property Modified
      • wrap_children property Modified
        • custom_fields property Modified
      • contract_enquiry_account property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
      • group_scheme property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/cover
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/claim
  • Response
  • 201 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • clients property Modified
        • custom_fields property Modified
      • modelable property Modified
        • custom_fields property Modified
      • adviser property Modified
        • custom_fields property Modified
      • case property Modified
        • custom_fields property Modified
      • existing_plan property Modified
        • custom_fields property Modified
POST /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/leads/{lead_uuid}/contact-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/leads/{lead_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/leads/{lead_uuid}/addresses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/import/start/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/import/map/{import_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/illustration/{illustration_uuid}/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
POST /api/v1/illustration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • custom_fields property Modified
GET /api/v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v2/roles/{role_uuid}/assignees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
GET /api/v2/risks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v2/plans/linked-policy-numbers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v2/plans/line-graph
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields properties Modified
GET /api/v2/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields properties Modified
GET /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • custom_fields property Modified
GET /api/v2/mortgage-searches
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • cases property Modified
GET /api/v2/holdings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan property Modified
GET /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v2/goals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v2/employments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
POST /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • custom_fields property Modified
      • plans property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/business-units
  • Response
  • 201 response Modified
    • application/json content type Modified
      • members property Modified
        • custom_fields property Modified
POST /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/addons/seccl/{addon}/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • custom_fields property Modified
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PATCH /api/v1/checklist-item/{checklistItem_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checked_by property Modified
        • custom_fields property Modified
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • clients property Modified
        • custom_fields property Modified
      • modelable property Modified
        • custom_fields property Modified
      • adviser property Modified
        • custom_fields property Modified
      • case property Modified
        • custom_fields property Modified
      • existing_plan property Modified
        • custom_fields property Modified
PUT /api/v1/mailboxes/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
PUT /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/leads/{lead_uuid}/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
PUT /api/v1/leads/{lead_uuid}/addresses/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • author property Modified
        • custom_fields property Modified
      • chargeable property Modified
        • custom_fields property Modified
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retired_at, is_retired, has_data properties Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • custom_fields property Modified
      • participants property Modified
        • custom_fields property Modified
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • custom_fields property Modified
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v2/risks/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
PUT /api/v2/plans/{plan_uuid}/linked-policy-numbers/{uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
PUT /api/v2/mortgage-searches/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cases property Modified
        • custom_fields property Modified
PUT /api/v2/goals/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v2/employments/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
PUT /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
      • accounts property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • linked_owners property Modified
        • custom_fields property Modified
      • linked_plans property Modified
        • custom_fields property Modified
      • cases property Modified
        • custom_fields property Modified
      • wrap property Modified
        • custom_fields property Modified
      • wrap_children property Modified
        • custom_fields property Modified
      • contract_enquiry_account property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
      • plan property Modified
        • custom_fields property Modified
      • transferred_from_plan property Modified
        • custom_fields property Modified
PUT /api/v1/plans/{plan_uuid}/ownership
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
      • accounts property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • linked_owners property Modified
        • custom_fields property Modified
      • linked_plans property Modified
        • custom_fields property Modified
      • cases property Modified
        • custom_fields property Modified
      • wrap property Modified
        • custom_fields property Modified
      • wrap_children property Modified
        • custom_fields property Modified
      • contract_enquiry_account property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
PUT /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
POST /api/v2/goals
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v2/employments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v2/dependants
  • Response
  • 201 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
POST /api/v2/contact-details
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • taskable property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • custom_fields property Modified
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • custom_fields property Modified
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
POST /api/v1/report
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
POST /api/v1/provider-statement/upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/provider-statement/import
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
      • accounts property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • linked_owners property Modified
        • custom_fields property Modified
      • linked_plans property Modified
        • custom_fields property Modified
      • cases property Modified
        • custom_fields property Modified
      • wrap property Modified
        • custom_fields property Modified
      • wrap_children property Modified
        • custom_fields property Modified
      • contract_enquiry_account property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
      • group_scheme property Modified
        • custom_fields property Modified
POST /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 201 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
      • plan property Modified
        • custom_fields property Modified
      • transferred_from_plan property Modified
        • custom_fields property Modified
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
PUT /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
PUT /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • custom_fields property Modified
      • plans property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • custom_fields property Modified
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/account/{account_uuid}/out-of-office
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
POST /api/v2/risks
  • Response
  • 201 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
POST /api/v2/plans/{plan_uuid}/linked-policy-numbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/employment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/dependant
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants, plans, custom_fields properties Modified
GET /api/v1/client/{client_uuid}/all-notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/circles/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/circles/{circle_uuid}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/circles/{circle_uuid}/form-submissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, chargeable properties Modified
GET /api/v1/circles/{circle_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants properties Modified
GET /api/v1/circles/{circle_uuid}/charge-splits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/circles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • splitable, account properties Modified
GET /api/v1/charge-split/{chargeSplit_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • splitable property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • chargeable, account, author, seller properties Modified
GET /api/v1/conversation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants properties Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v1/client/{client_uuid}/staff-members/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/staff-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/client/{client_uuid}/signatures
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/client/{client_uuid}/risk/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • completed_by property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/risk
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • completed_by property Modified
GET /api/v1/client/{client_uuid}/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields properties Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/income
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/goal/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v1/client/{client_uuid}/goal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • shared_owner property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, chargeable properties Modified
GET /api/v1/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plannr_account property Modified
        • custom_fields property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{account_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants properties Modified
GET /api/v1/account/{account_uuid}/contact-detail/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/account/{account_uuid}/contact-detail
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/account/{account_uuid}/address/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/account/{account_uuid}/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
DELETE /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
DELETE /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
DELETE /api/v1/leads/{lead_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
DELETE /api/v1/account/{account_uuid}/out-of-office
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • participants property Modified
        • custom_fields property Modified
      • plans property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/cases/{case_uuid}/conversations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • case, participants properties Modified
GET /api/v1/cases
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • participants, plans, custom_fields properties Modified
GET /api/v1/business-units/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • members property Modified
        • custom_fields property Modified
GET /api/v1/business-units/{business_unit_uuid}/members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v1/business-units
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • members property Modified
GET /api/v1/bulk-actions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • executed_by property Modified
        • custom_fields property Modified
GET /api/v1/bulk-actions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • executed_by property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-executions/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/automation-executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/automation-blueprints
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/audits/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/plans/{plan_uuid}/transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, account properties Modified
GET /api/v1/plans/{plan_uuid}/sub-group-schemes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/premiums/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
      • plan property Modified
        • custom_fields property Modified
      • transferred_from_plan property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/premiums
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by, plan, transferred_from_plan properties Modified
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/plans/{plan_uuid}/illustrations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/group-scheme-members
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields, group_scheme properties Modified
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, chargeable properties Modified
GET /api/v1/plans/{plan_uuid}/cover/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/cover
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans/{plan_uuid}/claim/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/claim
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client property Modified
GET /api/v1/plans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • client, accounts, seller, linked_owners, linked_plans, cases, wrap, wrap_children, contract_enquiry_account, custom_fields properties Modified
GET /api/v1/notifications/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • custom_fields property Modified
      • triggered_by property Modified
        • custom_fields property Modified
GET /api/v1/notifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • notifiable property Modified
        • custom_fields property Modified
      • triggered_by property Modified
        • custom_fields property Modified
GET /api/v1/note/{notableType}/{notableUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, notable properties Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • clients property Modified
        • custom_fields property Modified
      • modelable property Modified
        • custom_fields property Modified
      • adviser property Modified
        • custom_fields property Modified
      • case property Modified
        • custom_fields property Modified
      • existing_plan property Modified
        • custom_fields property Modified
GET /api/v2/dependants/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shared_owner property Modified
        • custom_fields property Modified
GET /api/v2/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taskable property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • taskable, custom_fields properties Modified
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • locked_by property Modified
        • custom_fields property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/statement
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • locked_by property Modified
GET /api/v1/report/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
GET /api/v1/report-template/{reportTemplate_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • created_by property Modified
        • custom_fields property Modified
GET /api/v1/report-template
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/report
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • client property Modified
        • custom_fields property Modified
      • accounts property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • linked_owners property Modified
        • custom_fields property Modified
      • linked_plans property Modified
        • custom_fields property Modified
      • cases property Modified
        • custom_fields property Modified
      • wrap property Modified
        • custom_fields property Modified
      • wrap_children property Modified
        • custom_fields property Modified
      • contract_enquiry_account property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/plans/{plan_uuid}/transaction-schedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, account properties Modified
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v1/form/{form_uuid}/submission/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
      • seller property Modified
        • custom_fields property Modified
      • author property Modified
        • custom_fields property Modified
      • chargeable property Modified
        • custom_fields property Modified
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account, seller, author, chargeable properties Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/employee/{employee}/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/employee/{employee_uuid}/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/document-signing/{signatureTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • launched_by property Modified
        • custom_fields property Modified
GET /api/v1/document-signing
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • launched_by property Modified
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retired_at, is_retired, has_data properties Added
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retired_at, is_retired, has_data properties Added
  • Query
  • filter[is_retired] query parameter Added
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • case property Modified
        • custom_fields property Modified
      • participants property Modified
        • custom_fields property Modified
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • author property Modified
        • custom_fields property Modified
GET /api/v1/conversation/{conversation_uuid}/messages
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • plan, clients, modelable, adviser, case, existing_plan properties Modified
GET /api/v1/me/logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/me
  • Response
  • 200 response Modified
    • application/json content type Modified
      • current_account property Modified
        • custom_fields property Modified
GET /api/v1/mailboxes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • created_by property Modified
GET /api/v1/logs/{modelType}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • author, modelable, through, account properties Modified
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/leads/{lead_uuid}/contact-details/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/leads/{lead_uuid}/contact-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/leads/{lead_uuid}/addresses/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Modified
        • custom_fields property Modified
GET /api/v1/leads/{lead_uuid}/addresses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • accounts property Modified
GET /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • custom_fields property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_adviser property Modified
        • custom_fields property Modified
      • assigned_administrator property Modified
        • custom_fields property Modified
      • assigned_paraplanner property Modified
        • custom_fields property Modified
      • introduced_by property Modified
        • custom_fields property Modified
      • owners property Modified
        • custom_fields property Modified
      • custom_fields property Modified
        • is_retired property Added
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • assigned_adviser, assigned_administrator, assigned_paraplanner, introduced_by, owners, custom_fields properties Modified
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • custom_fields property Modified
GET /api/v1/import
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • account property Modified
GET /api/v1/illustration/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • custom_fields property Modified
      • requested_by property Modified
        • custom_fields property Modified
Added 1
GET /api/v1/addons/mortgagebrain/connections
397 structure changes including:
397 Modifications
Modified 397 Breaking
DELETE /api/v1/account/{account_uuid}/address/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/account/{account_uuid}/login/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/account/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/addon-subscriptions/{addonSubscription_uuid}/unsubscribe
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/business-units/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/cases-status/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/cases-type/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/checklist-item/{checklistItem_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/checklist/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/client/{client_uuid}/expenditure/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/client/{client_uuid}/income/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/client/{client_uuid}/linked-clients/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/custom-field/{customField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/document-pack/document-pack/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/file/{file}/forceDelete
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/file/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}/{key}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/firm/{firm_uuid}/network-settings/{key}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/firm/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/folder/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/import/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/lead-interests/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/lead-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{lead_uuid}/addresses/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{lead_uuid}/archive
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{lead_uuid}/assign
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{lead_uuid}/contact-details/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{lead_uuid}/introducer
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/leads/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/life-stage/{lifeStage_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/note/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/notifications/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/oauth/connections/{oauthConnection_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/report-template/{reportTemplate_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/report/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/service-level/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/submission-request/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/tag/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/time-entry/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/workflow/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v2/circles/{circle_uuid}/expenditures/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/account/{account_uuid}/address
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/account/{account_uuid}/address/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/account/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addon
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addon-subscriptions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addon/{addon_id}/sub-firm-availability
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/be-iq/client/{client_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/mortgagebrain/ready
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/client-products/{account_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details/status
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/direct-debit-mandate
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/nodes
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/schema-products
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/seccl/{addon}/search-assets
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/addons/transact/advisers
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/audit-log
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/audit-log/{audit}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/audits
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/audits/{model}/{modelUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blocks
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blocks/triggers
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-blueprints/{automationBlueprint_uuid}/executions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-executions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/automation-executions/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/business-units
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/business-units/{business_unit_uuid}/branding
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/business-units/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/cases-status
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/cases-type
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/cases-type/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/circles/{circle_uuid}/all-time-entries
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/circles/{circle_uuid}/emails
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/circles/{circle_uuid}/fact-find-access
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/circles/{circle_uuid}/form-submissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • request property Modified
GET /api/v1/circles/{circle_uuid}/linked-clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/circles/{circle_uuid}/notes
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/all-notes
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/all-time-entries
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/expenditure
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/expenditure/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/linked-clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/plans
  • Query
  • filter[client_adviser_uuids], filter[has_active_adviser] query parameters Added
GET /api/v1/client/{client_uuid}/potential-duplicates
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{conversation_uuid}/message/{message_uuid}/edits
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{conversation_uuid}/messages
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/custom-field
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/custom-field/{customField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/custom-linked-form-questions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/document-pack/document-pack/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/employee/{employee_uuid}/audits
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/employee/{employee}/logs
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/expenditure-structure/field
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/expenditure-structure/section
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/file/bin
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/file/{file_uuid}/download
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/file/{file_uuid}/download/temporary-url
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/file/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/files/{model}/{modelUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/conversation-cover
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/documents
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/network-settings
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/network-settings/configuration-controls
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{firm_uuid}/network-settings/governance
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/firm/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/folder/{folder_uuid}/files
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/folder/{folder_uuid}/tree
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/folder/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • request property Modified
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • request property Modified
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/form/{form_uuid}/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • receiver property Added
GET /api/v1/form/{form_uuid}/submission/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • request property Modified
        • receiver property Added
GET /api/v1/import
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/import/keys/{importer}/{mode}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/import/modes/{importer}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/import/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-interests
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-interests/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-sources
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-sources/{lead_source_uuid}/sub-sources
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/lead-sub-sources
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads/{lead_uuid}/addresses
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads/{lead_uuid}/addresses/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads/{lead_uuid}/contact-details
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads/{lead_uuid}/contact-details/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/leads/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/life-stage
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/life-stage/{lifeStage_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/linked-form-questions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/logs/{modelType}/{modelUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/marketplace-audit-log
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/marketplace-audit-log/export
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/marketplace-audit-log/{audit}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/me/logs
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/aum
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/cases
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/cases/completed
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/conversations
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/documents/generated
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/fact-finds/sent
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/files/uploaded
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/introducers
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/messages/sent
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/plans
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/signatures
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/tasks
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/tasks/completed
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/metrics/time-logged
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/note/{notableType}/{notableUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/note/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/notifications
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/notifications/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/oauth/connections
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/oauth/providers
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans
  • Query
  • filter[client_adviser_uuids], filter[has_active_adviser] query parameters Added
GET /api/v1/plans/{plan_uuid}/contributions/{subAccount}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/holdings/{subAccount}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/valuations/{subAccount}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/platform/{id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/portal-engagement/summary
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/report
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/report-template
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/report-template/{reportTemplate_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/report-type
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/report/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/service-level
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/service-level/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/submission-request
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • receiver property Added
GET /api/v1/submission-request/received/{account}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • receiver property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/submission-request/sent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • receiver property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/submission-request/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • receiver property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/tag
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/task/{task_uuid}/checklists
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/time-entry/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{workflow_uuid}/breadcrumbs
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{workflow_uuid}/task
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/workflow/{workflow_uuid}/tree
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v2/circles/{circle_uuid}/expenditures
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v2/circles/{circle_uuid}/expenditures/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v2/flux
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PATCH /api/v1/checklist-item/{checklistItem_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PATCH /api/v1/checklist/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PATCH /api/v1/task/{task_uuid}/archive
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PATCH /api/v1/task/{task_uuid}/unarchive/{taskStatus_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account/check-duplicates
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account/{account_uuid}/address
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account/{account_uuid}/login
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/confirm-payment
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/disable
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addon-subscriptions/{addonSubscription_uuid}/enable
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/be-iq/profiler/invite
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/conquest/client/{client}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/mortgagebrain/mortgage-search
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/nucleus/sync-clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/nucleus/sync-plans
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/associate-node
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/client
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/bank-details
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/direct-debit-mandate/portal-completion
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/client/{account_uuid}/products/{clientProductId}/accept
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/direct-debit-mandate
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/sync-client/{account_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/sync-clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/sync-plan/{plan_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/seccl/{addon}/sync-plans
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/addons/transact/account-opening
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-blueprints
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/trigger
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/webhook-targets
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-step/{automationStep_uuid}/start
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/automation-step/{automationStep_uuid}/stop
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/bank-transaction/reconcile
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/business-units
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/business-units/{business_unit_uuid}/members/{action}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/cases-status
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/cases-type
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/checklist/{checklist_uuid}/items
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client-status
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/expenditure/sync-to-circle
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/linked-clients
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/client/{client_uuid}/potential-duplicates/dismiss
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/clone/{modelType}/{modelUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation_uuid}/messages
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation/{conversation_uuid}/messages/inline
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/custom-field
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/document-pack/document-pack
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expectation/balance
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expectation/reconcile
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expectation/unbalance
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expenditure-structure/field
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expenditure-structure/field/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expenditure-structure/section
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expenditure-structure/section/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/expenditure-structure/section/set-custom-expenditure
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/fact-find/request/{factFindRequest_uuid}/create-account
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/file
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/file/create-file-record
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/file/direct-upload
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/firm/{firm_uuid}/branding
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/firm/{firm_uuid}/settings
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/folder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/folder/{folder_uuid}/permissions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/form/{form_uuid}/submission
  • Response
  • 200 response Modified
    • application/json content type Modified
      • request property Modified
        • receiver property Added
POST /api/v1/form/{form_uuid}/submission-request/{account_uuid}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • receiver property Added
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/answer
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/form/{form_uuid}/submission/{submission_uuid}/submit
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/illustration/{illustration_uuid}/proceed
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/import
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/import/map/{import_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/import/start/{import_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/lead-interests
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/lead-sources
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/lead-sources/{lead_source_uuid}/sub-sources
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads
  • Body
  • application/json content type Modified
    • email, phone properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • contact_details property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads/{lead_uuid}/addresses
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads/{lead_uuid}/archive
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads/{lead_uuid}/assign
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads/{lead_uuid}/contact-details
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/leads/{lead_uuid}/introducer
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/life-stage
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/life-stage/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/migrate-joint-documents-to-circle
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/note
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/notifications/read-all
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/notifications/read/{notification_id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/notifications/subscribe/{subscribeableType}/{subscribeableUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/notifications/unread/{notification_id}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/notifications/unsubscribe/{subscribeableType}/{subscribeableUuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/sync-holdings
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/report
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/report-template
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/service-level
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/subscribe
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/tag
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/task/{task_uuid}/checklists
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/time-entry
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/time-entry/{timeEntry_uuid}/stop
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/workflow
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/workflow/{workflow_uuid}/run
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/workflow/{workflow_uuid}/task
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/checklists
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/custom/{expenditure_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/circles/{circle_uuid}/expenditures/{lifeStage_uuid}/{lifeStageField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/fact-find/blocks/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/fact-find/questions/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/fact-find/sections/reorder
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v2/webhook-subscriptions/calls/{outgoingWebhookCall_uuid}/retry
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/account/{account_uuid}/address/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/account/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/addon-subscriptions/{addonSubscription_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/addon/{addon_id}/sub-firm-availability
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/addons/conquest/client/{client}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps/{blueprintStep_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/business-units/{business_unit_uuid}/branding
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/business-units/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/cases-status/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/cases-type/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/circles/{circle_uuid}/fact-find-access
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/client/{client_uuid}/linked-clients/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/conversation/{conversation_uuid}/messages/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/custom-field/{customField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/document-pack/document-pack/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/expenditure-structure/field/{lifeStageField_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/expenditure-structure/section/{lifeStageSection_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/file/{file_uuid}/copy
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/file/{file}/restore
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/file/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{firm_uuid}/conversation-cover
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}/{key}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{firm_uuid}/network-settings/{key}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/folder/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • receiver property Added
PUT /api/v1/lead-interests/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/lead-sources/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/leads/{lead_uuid}/addresses/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/leads/{lead_uuid}/contact-details/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/leads/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/life-stage/{lifeStage_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/note/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/oauth/connections/{oauthConnection_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/holdings/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/valuations/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/withdrawals/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/plans/{plan_uuid}/sub-accounts/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/report-template/{reportTemplate_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/service-level/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/tag/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/time-entry/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/workflow/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/workflow/{workflow_uuid}/task/{workflowTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
9 structure changes including:
9 Modifications
Modified 9
GET /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • policy_type property Added
GET /api/v1/addons/pensionlab/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • policy_type property Added
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_type property Added
GET /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • policy_type property Added
POST /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • policy_type property Added
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/refresh
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_type property Added
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/resend
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_type property Added
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/signing-links/send
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_type property Added
POST /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • policy_type property Added
10 structure changes including:
10 Modifications
Modified 10
DELETE /api/v1/leads/{lead_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
DELETE /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
DELETE /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
GET /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • can_view_promoted property Added
GET /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
POST /api/v1/leads
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
POST /api/v1/leads/{lead_uuid}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
POST /api/v1/leads/{lead_uuid}/assign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
POST /api/v1/leads/{lead_uuid}/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
PUT /api/v1/leads/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_view_promoted property Added
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
  • Query
  • filter[state] query parameter Added
GET /api/v1/addons/pensionlab/letters-of-authority
  • Query
  • filter[state] query parameter Added
GET /api/v1/addons/pensionlab/letters-of-authority/export
  • Query
  • filter[state] query parameter Added
GET /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
  • Query
  • filter[state] query parameter Added
Added 1
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/events
1 structure change including:
1 Addition
Added 1
GET /api/v1/addons/pensionlab/me/letters-of-authority