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

Jan 31, 2025

main
1.0.0
Compare

API structure has changed

19 structure changes including:
19 Modifications
Modified 19 Breaking
GET /api/v1/account/{account_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/cases/{case_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/circles/{circle_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/conversation/{conversation_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/file/bin
  • Query
  • include query parameter Added
GET /api/v1/file/{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
      • path, folder, documentable_type, documentable, navigator properties Added
GET /api/v1/files/{model}/{modelUuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • path, folder, documentable_type, documentable, navigator properties Added
  • Query
  • include query parameter Added
GET /api/v1/firm/{firm_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/folder/{folder_uuid}/files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • path, folder, documentable_type, documentable, navigator properties Added
  • Query
  • include query parameter Added
GET /api/v1/folder/{folder_uuid}/tree
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/illustration/{illustration_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
GET /api/v1/plans/{plan_uuid}/documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
POST /api/v1/file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • path, folder, documentable_type, documentable, navigator properties Added
POST /api/v1/file/direct-upload
  • Response
  • 201 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • path, folder, documentable_type, documentable, navigator properties Added
POST /api/v1/folder
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added
PUT /api/v1/file/{file_uuid}/copy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parent property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • path, folder, documentable_type, documentable, navigator properties Added
PUT /api/v1/file/{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
      • path, folder, documentable_type, documentable, navigator properties Added
PUT /api/v1/folder/{uuid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documentable property Added