Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Aug 29, 2025

main
v1.30.0
Compare
v1.30.0

API structure has changed

78 structure changes including:
78 Modifications
Modified 78
DELETE /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/bank-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/charge
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/circles/{circle_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/client/{client_uuid}/emails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client_uuid}/owners
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{client}/shared-accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/file/bin
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/group/{group_uuid}/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/logins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/mailboxes/message/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/new-business-event
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/plans/{plan_uuid}/expectations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/plans/{plan_uuid}/new-business-events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
GET /api/v2/shareholder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firm property Modified
GET /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/check
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/expire
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/account/{account_uuid}/login/{login_uuid}/make-primary
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/bank-transaction
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/client
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/custom-field
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/employee
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/expectation/reconcile
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
POST /api/v1/introducer
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/provider-statement/upload
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
POST /api/v2/shareholder
  • Response
  • 201 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/check/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{account_uuid}/login/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/account/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/client/{client_uuid}/owners/personal-details/{owner_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/client/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/custom-field/{customField_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/employee/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/expectation/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/file/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • brand_colours property Modified
        • portal_sidebar_user_select_background, portal_sidebar_user_select_hover, portal_sidebar_user_select_text, portal_sidebar_user_select_text_hover, portal_sidebar_user_select_border, portal_sidebar_user_select_border_hover properties Added
PUT /api/v1/introducer/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v1/statement-transaction/{statementTransaction_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified
PUT /api/v2/shareholder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • firm property Modified
        • brand_colours property Modified