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

Changelog

Last update:
Compare
14 structure changes including:
2 Additions
12 Modifications
Modified 12 Breaking
GET /api/v1/account/{account_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/cases/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/conversation/{conversation_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/file/bin
  • Query
  • filter[name], filter[date_from], filter[date_to], filter[extension], filter[uploaded_by_uuid], filter[size], filter[last_modified_from], filter[last_modified_to], filter[original_created_from], filter[original_created_to] query parameters Added
GET /api/v1/files/{model}/{modelUuid}
  • Query
  • filter[uploaded_by_uuid] query parameter Added
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ancestors property Added
Added 2
GET /api/v1/circles/{circle_uuid}/documents
GET /api/v1/folder/{folder_uuid}/files
5 structure changes including:
5 Additions
Added 5
DELETE /api/v2/risks/{uuid}
GET /api/v2/risks
GET /api/v2/risks/{uuid}
POST /api/v2/risks
PUT /api/v2/risks/{uuid}
5 structure changes including:
5 Additions
Added 5
DELETE /api/v2/goals/{uuid}
GET /api/v2/goals
GET /api/v2/goals/{uuid}
POST /api/v2/goals
PUT /api/v2/goals/{uuid}
4 structure changes including:
1 Breaking change
3 Modifications
1 Removal
Modified 3 Breaking
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan, clients properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
Removed 1 Breaking
GET /api/v1/new-business-event
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
9 structure changes including:
6 Additions
3 Modifications
Modified 3
GET /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Added
POST /api/v1/new-business-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • plan, clients properties Added
PUT /api/v1/new-business-event/{newBusinessEvent_uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan, clients properties Added
Added 6
DELETE /api/v2/employments/{uuid}
GET /api/v1/new-business-event
GET /api/v2/employments
GET /api/v2/employments/{uuid}
POST /api/v2/employments
PUT /api/v2/employments/{uuid}
2 structure changes including:
2 Modifications
Modified 2
POST /api/v1/note
  • Body
  • application/json content type Modified
    • visible_to_clients property Added
PUT /api/v1/note/{uuid}
  • Body
  • application/json content type Modified
    • visible_to_clients property Added
17 structure changes including:
11 Additions
6 Modifications
Modified 6
PUT /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
PUT /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
POST /api/v1/client/{client_uuid}/income
  • Response
  • 201 response Modified
    • application/json content type Modified
      • account property Added
POST /api/v1/client/{client_uuid}/dependant
  • Response
  • 201 response Modified
    • application/json content type Modified
      • accounts property Added
GET /api/v1/client/{client_uuid}/income/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Added
GET /api/v1/client/{client_uuid}/dependant/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accounts property Added
Added 11
PUT /api/v2/income/{uuid}
PUT /api/v2/dependants/{uuid}
POST /api/v2/income
POST /api/v2/dependants
POST /api/v1/integrations/{passportClient_id}/revoke
GET /api/v2/income/{uuid}
GET /api/v2/income
GET /api/v2/dependants/{uuid}
GET /api/v2/dependants
DELETE /api/v2/income/{uuid}
DELETE /api/v2/dependants/{uuid}
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /api/v1/note
  • Body
  • application/json content type Modified
    • visible_to_clients property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /api/v1/note/{uuid}
  • Body
  • application/json content type Modified
    • visible_to_clients property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
2 structure changes including:
2 Modifications
Modified 2
POST /api/v1/note
  • Body
  • application/json content type Modified
    • visible_to_clients property Added
PUT /api/v1/note/{uuid}
  • Body
  • application/json content type Modified
    • visible_to_clients property Added
3 structure changes including:
2 Additions
1 Modification
Modified 1 Breaking
GET /api/v1/client/{client_uuid}/all-time-entries
  • Query
  • filter[uuid], filter[accounts] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[account_uuids] query parameter Added
Added 2
GET /api/v1/circles/{circle_uuid}/all-time-entries
GET /api/v1/circles/{circle_uuid}/emails
18 structure changes including:
5 Additions
13 Modifications
Modified 13 Breaking
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/task
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/submission-request/sent
  • Query
  • filter[form_title], filter[sender_uuids], filter[receiver_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/submission-request/received/{account}
  • Query
  • filter[form_title], filter[sender_uuids], filter[receiver_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/submission-request
  • Query
  • filter[form_title], filter[sender_uuids], filter[receiver_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/form/{form_uuid}/submission-request
  • Query
  • filter[form_title], filter[sender_uuids], filter[receiver_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/form/{form_uuid}/submission-authored-by/{author_uuid}
  • Query
  • filter[form.title] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[account_uuids], filter[submitted_by_uuid], filter[circle_uuids] query parameters Added
GET /api/v1/form/{form_uuid}/submission
  • Query
  • filter[form.title] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • filter[account_uuids], filter[submitted_by_uuid], filter[circle_uuids] query parameters Added
GET /api/v1/document-signing
  • Query
  • filter[account_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/document
  • Query
  • filter[circle_uuids] query parameter Added
GET /api/v1/client/{client_uuid}/signatures
  • Query
  • filter[account_uuids], filter[circle_uuids] query parameters Added
GET /api/v1/client/{client_uuid}/cases
  • Query
  • filter[account_uuids], filter[circle_uuids], filter[employee_account_uuids] query parameters Added
GET /api/v1/cases
  • Query
  • filter[account_uuids], filter[circle_uuids], filter[employee_account_uuids] query parameters Added
Added 5
PUT /api/v1/circles/{uuid}
POST /api/v1/circles
GET /api/v1/circles/{uuid}
GET /api/v1/circles
DELETE /api/v1/circles/{uuid}
1 structure change including:
1 Modification
Modified 1
POST /api/v1/client/{client_uuid}/goal
  • Body
  • application/json content type Modified
    • target_amount property Modified
      • Property is no longer required