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
v1.159.0
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
v1.158.2
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
v1.158.1
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
v1.158.0
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
v1.157.0
1 structure change including:
1 Addition
Added 1
GET /api/v1/addons/pensionlab/me/letters-of-authority
v1.156.6
24 structure changes including:
21 Additions
3 Modifications
Modified 3
GET /api/v1/options/custom-fields
  • Response
  • 200 response Modified
    • application/json content type Modified
      • 5 property Added
DELETE /api/v1/lead-sources/{uuid}
  • Response
  • 409 response Added
DELETE /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Response
  • 409 response Added
Added 21
PUT /api/v1/leads/{uuid}
PUT /api/v1/leads/{lead_uuid}/contact-details/{uuid}
PUT /api/v1/leads/{lead_uuid}/addresses/{uuid}
POST /api/v1/leads/{lead_uuid}/introducer
POST /api/v1/leads/{lead_uuid}/contact-details
POST /api/v1/leads/{lead_uuid}/assign
POST /api/v1/leads/{lead_uuid}/archive
POST /api/v1/leads/{lead_uuid}/addresses
POST /api/v1/leads
GET /api/v1/leads/{uuid}
GET /api/v1/leads/{lead_uuid}/contact-details/{uuid}
GET /api/v1/leads/{lead_uuid}/contact-details
GET /api/v1/leads/{lead_uuid}/addresses/{uuid}
GET /api/v1/leads/{lead_uuid}/addresses
GET /api/v1/leads
DELETE /api/v1/leads/{uuid}
DELETE /api/v1/leads/{lead_uuid}/introducer
DELETE /api/v1/leads/{lead_uuid}/contact-details/{uuid}
DELETE /api/v1/leads/{lead_uuid}/assign
DELETE /api/v1/leads/{lead_uuid}/archive
DELETE /api/v1/leads/{lead_uuid}/addresses/{uuid}
v1.156.5
12 structure changes including:
1 Addition
11 Modifications
Modified 11 Breaking
GET /api/v1/audits
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200, 422 responses Added
  • Query
  • filter[auditable_type] query parameter Added
GET /api/v1/audits/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • auditable_uuid property Added
GET /api/v1/employee/{employee_uuid}/audits
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • auditable_uuid property Added
GET /api/v1/lead-sources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sub_sources property Added
  • Query
  • include query parameter Added
GET /api/v1/lead-sources/{lead_source_uuid}/sub-sources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • lead_source property Added
GET /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lead_source property Added
GET /api/v1/lead-sources/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_sources property Added
POST /api/v1/lead-sources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_sources property Added
POST /api/v1/lead-sources/{lead_source_uuid}/sub-sources
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lead_source property Added
PUT /api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lead_source property Added
PUT /api/v1/lead-sources/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sub_sources property Added
Added 1
GET /api/v1/lead-sub-sources
v1.156.4
7 structure changes including:
7 Additions
Added 7
GET /api/v1/addons/pensionlab/clients/{client_id}/detail-suggestions
GET /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
GET /api/v1/addons/pensionlab/letters-of-authority
GET /api/v1/addons/pensionlab/letters-of-authority/export
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/download/certificate
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/download/letter
GET /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
v1.156.3
6 structure changes including:
2 Additions
4 Modifications
Modified 4
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • closed_sub_state, issues, notes, estimated_completion, finished_policies_fraction, client_signed_at, second_owner_signed_at, signed_at, sent_at, completed_at, closed_at, last_synced_at, sync_error properties Added
POST /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • closed_sub_state, issues, notes, estimated_completion, finished_policies_fraction, client_signed_at, second_owner_signed_at, signed_at, sent_at, completed_at, closed_at, last_synced_at, sync_error properties Added
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/signing-links/send
  • Response
  • 200 response Modified
    • application/json content type Modified
      • closed_sub_state, issues, notes, estimated_completion, finished_policies_fraction, client_signed_at, second_owner_signed_at, signed_at, sent_at, completed_at, closed_at, last_synced_at, sync_error properties Added
POST /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
  • Response
  • 200 response Modified
    • application/json content type Modified
      • closed_sub_state, issues, notes, estimated_completion, finished_policies_fraction, client_signed_at, second_owner_signed_at, signed_at, sent_at, completed_at, closed_at, last_synced_at, sync_error properties Added
Added 2
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/refresh
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/resend
v1.156.2
6 structure changes including:
6 Additions
Added 6
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}
GET /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/signing-links
GET /api/v1/addons/pensionlab/providers
POST /api/v1/addons/pensionlab/clients/{client_id}/letters-of-authority
POST /api/v1/addons/pensionlab/letters-of-authority/{letterOfAuthority_uuid}/signing-links/send
POST /api/v1/addons/pensionlab/plans/{plan_uuid}/letters-of-authority
v1.156.0
1 structure change including:
1 Addition
Added 1
GET /api/v2/holdings
v1.155.0
3 structure changes including:
3 Modifications
Modified 3
GET /api/v1/addons/seccl/{addon}/client/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_details property Modified
        • verification_status property Added
      • record_creation_date property Added
PATCH /api/v1/addons/seccl/{addon}/client/{account_uuid}
  • Body
  • application/json content type Modified
    • aml property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_details property Modified
        • verification_status property Added
      • record_creation_date property Added
POST /api/v1/addons/seccl/{addon}/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bank_details property Modified
        • verification_status property Added
      • record_creation_date property Added
v1.154.20
4 structure changes including:
1 Breaking change
3 Additions
1 Removal
Removed 1 Breaking
POST /api/v1/addons/pensionlab/launch-widget
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
DELETE /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}/{key}
GET /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}
PUT /api/v1/firm/{firm_uuid}/network-settings/advisers/{employee_uuid}/{key}
v1.154.16
1 structure change including:
1 Modification
Modified 1
POST /api/v2/roles/{role_uuid}/{action}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • failed property Modified
        • Type went from array to array[string]
v1.154.15
14 structure changes including:
14 Modifications
Modified 14
DELETE /api/v1/firm/{firm_uuid}/network-settings/{key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exception property Added
GET /api/v1/firm/{firm_uuid}/network-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • exception property Added
GET /api/v1/firm/{firm_uuid}/network-settings/governance
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • exception property Added
GET /api/v1/task
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • workflow_task property Modified
GET /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Modified
        • workflow property Modified
GET /api/v1/workflow
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network_locked property Added
GET /api/v1/workflow/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network_locked property Added
PATCH /api/v1/task/{task_uuid}/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Modified
        • workflow property Modified
PATCH /api/v1/task/{task_uuid}/uncomplete/{taskStatus}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Modified
        • workflow property Modified
POST /api/v1/task
  • Response
  • 201 response Modified
    • application/json content type Modified
      • workflow_task property Modified
        • workflow property Modified
POST /api/v1/workflow
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network_locked property Added
PUT /api/v1/firm/{firm_uuid}/network-settings/{key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exception property Added
PUT /api/v1/task/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflow_task property Modified
        • workflow property Modified
PUT /api/v1/workflow/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network_locked property Added
v1.154.14
8 structure changes including:
7 Additions
1 Modification
Modified 1
GET /api/v1/audit-log
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • parent_firm property Added
Added 7
GET /api/v1/addon/{addon_id}/sub-firm-availability
GET /api/v1/firm/{firm_uuid}/network-settings/configuration-controls
GET /api/v1/marketplace-audit-log
GET /api/v1/marketplace-audit-log/export
GET /api/v1/marketplace-audit-log/{audit}
PUT /api/v1/addon/{addon_id}/sub-firm-availability
PUT /api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls
v1.154.13
2 structure changes including:
2 Additions
Added 2
GET /api/v1/audit-log
GET /api/v1/audit-log/{audit}