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

Nov 16, 2022

main
1.0.0
Compare

API structure has changed

44 structure changes including:
8 Breaking changes
8 Additions
28 Modifications
8 Removals
Modified 28 Breaking
GET /api/v1/client/{client}/shared-accounts
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • is_admin property Added
GET /api/v1/employee
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Query
  • filter[name], filter[email], filter[type], filter[created_after], filter[created_before], filter[tags], filter[groups] query parameters Added
GET /api/v1/employee/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Response
  • 200 response Added
GET /api/v1/group
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/group/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/introducer
  • Query
  • filter[name], filter[email], filter[type], filter[created_after], filter[created_before], filter[tags], filter[groups] query parameters Added
GET /api/v1/plans
  • Query
  • filter[abstract_type], filter[type], filter[name], filter[client], filter[policy_number], filter[provider], filter[seller], filter[case], filter[valuation_from], filter[valuation_to], filter[custom_field:REFERENCE] query parameters Added
GET /api/v1/tasks
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Query
  • filter[custom_field:REFERENCE] query parameter Added
POST /api/v1/board/{board_uuid}/list/{boardList_uuid}/task
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/conversation
  • Response
  • 200 response Modified
    • is_admin property Added
POST /api/v1/employee
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/group
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/group/{group_uuid}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/conversation/{uuid}
  • Response
  • 200 response Modified
    • is_admin property Added
PUT /api/v1/employee/{uuid}
  • Body
  • content type Modified
    • groups property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Response
  • 200 response Added
PUT /api/v1/group/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/employee/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Response
  • 200 response Added
DELETE /api/v1/group/{group_uuid}/participants
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
DELETE /api/v1/group/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/board/{board_uuid}/list/{boardList_uuid}/task
  • Query
  • per_page query parameter Removed
  • filter[due_at], filter[completed], filter[groups], filter[clients], filter[participants], filter[custom_field:REFERENCE] query parameters Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/board/{board_uuid}/list/{boardList_uuid}/task/{boardTask_uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/cases/{uuid}
  • Response
  • 200 response Added
GET /api/v1/client
  • Query
  • group query parameter Removed
  • filter[groups] query parameter Added
GET /api/v1/client/{client_uuid}/signatures
  • Query
  • filter[clients] query parameter Added
GET /api/v1/client/{client_uuid}/wealth
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
Removed 8 Breaking
GET /api/v1/cases/{case_uuid}/conversations
GET /api/v1/cases/{case_uuid}/documents
GET /api/v1/client/{client_uuid}/cases
GET /api/v1/client/{client_uuid}/conversations
GET /api/v1/client/{client_uuid}/documents
GET /api/v1/client/{client_uuid}/groups
GET /api/v1/conversation/{conversation_uuid}/documents
GET /api/v1/firm/{firm_uuid}/documents
Added 8
GET /api/v1/firm/{firm_uuid}/documents
GET /api/v1/conversation/{conversation_uuid}/documents
GET /api/v1/client/{client_uuid}/cases
GET /api/v1/cases/{case_uuid}/documents
GET /api/v1/cases/{case_uuid}/conversations
GET /api/v1/account/{account_uuid}/groups
GET /api/v1/account/{account_uuid}/documents
GET /api/v1/account/{account_uuid}/conversations