December 2024

API version 1.1230.0

Changes or new features:

  • Update GET office endpoints (/api/1/offices, /api/1/offices/{firmId}, /api/1/offices/{firmId}/officeId}) to have an array of billing Infos instead of a single item to support multiple billing contacts per office
  • Update PUT (/api/1/offices/{officeId}) and POST (/api/1/offices) endpoints to have an array of billing infos instead of a single item to support multiple billing contacts per office
  • Remove isValid flag from dinger endpoints - used during migrations from the legacy system, this attribute is no longer needed
  • Update case collections endpoints (/api/1/collections, /api/1/collections/{id}) to use Civil Lawsuit ID (INT) instead of Case ID (GUID+) for the id attribute of civil cases

Bug fixes:

  • Fix bug where the court details endpoint would not return results
  • Fix bug where the court details endpoint was returning out of date information due to updates because of caching

November 2024

API version 1.1210.0

Changes or new features:

  • Remove fullText attribute from civil litigation search results (slowed down search times and greatly increased weight of response)
  • Add new properties to the civil litigation search results to indicate if the full text version of the complaint is available, and the number of matches within the full text if any matches were found during search: hasFullText, fullTextMatchesCount
  • Create new endpoint for retrieving the full text of a case if available, with highlights: /api/1/civil-lawsuit/{civilLawsuitId}/complaint-text
  • Add hitsCount attribute for how many hits a dinger setup has had to the /dingers/:dingerId/settings-history endpoint
  • Update /api/1/me/recent-cases endpoint to use the new integer ID for civil litigation cases
  • Create new dinger snapshot endpoint that does not require any case identifier: /api/1/dingers/{id}/hit/{hitId}/snapshot
  • Add ability to sort /api/1/offices by dingerCount and activeUserCount
  • Change the file naming convention for exported dinger hit histories to: CasePortal {Library Type} Dinger ID {ID} Hits_MM_DD_YYYY (PST)
  • Add additional attributes to the /api/1/firms/{firmId} endpoint for identifying which office pays the pricing plan, and if that office also pays for ad hoc charges: firmBillingOfficeId, firmBillingOfficePaysAllAdHoc

Bug fixes:

  • Fix bug where a paused tracker could be re-activated even if the case was no longer trackable
  • Fix bug where a tracker could be created even though the case was a temporary case (temporary cases cannot be tracked)
  • Fix bug where certain characters in the search input of filters would crash the filters endpoint response
  • Fix bug where the fullTextMatchesCount returned in search results did not match the number of marked items in the full text data

October 2024

API version 1.1165.0

Changes or new features:

  • Update attribute reportName to report for the GET ​/api​/1​/cns-reports​/hits​/{reportId}​/cases endpoint and change it from a string to an array of objects that include information about report title, id, and date, so that we can see when a case was included in multiple reports: { "title": "Some title", "reportId": 123, "createdAt": "2024-08-18T18:45:23.58923Z" }
  • Update GET /api/1/paper-filing endpoint to include the (requestors) message in the returned model

September 2024

API version 1.1129.1

Changes or new features:

  • Add attribute trackersWithUpdates to endpoint /api/1/firms/activity which represents the number of tracker runs that had updates

Bug fixes:

  • Fix bug where the /api/1/services/{serviceId} endpoint sometimes threw a 500 error
  • Fix bug where the finishedAtUTC date time attribute in the /api/1/paper-filing endpoint was sometimes not correctly updated after a document request was canceled
  • Fix bug where the ​/api​/1​/trackers​/on-demand​/{caseId}​/is-in-progress endpoint which provides the status of a docket-on-demand request sometimes returned a 500 error

August 2024

API version 1.1101.0

Changes or new features:

  • no major changes

Bug fixes:

  • Fix bug where usage data was incorrect in certain situations
  • Fix Export to Excel error when trying to export past hits / total hits for a dinger 

July 2024

API version 1.1069.0

Changes or new features:

  • Create a new POST endpoint, /api/1/dingers/projected-cost for getting the projected cost of a dinger prior to it being created
  • Add status to docket sheet endpoint, /api/1/civil-litigation/{caseId}/docket-entries/paper-filing/status, to indicate that the document is not possible to retrieve
  • Update docket sheet endpoint status for when a request is complete, from "Finished" to "Fulfilled"
  • Add "creditorsDoNotExist" property to the GET /api/1/bankruptcy/{bankruptcyId} endpoint for when creditors are never released for a bankruptcy case
  • Add "isNationwide" to dinger activity reports endpoint, /api/1/dingers/report, to indicate whether or not a Dinger is Nationwide (only applies to Small & Regular Subscribers)
  • Create Nationwide dinger tier endpoint that lists all Nationwide tiers, /api/1/nationwide-subscriptions/tiers (only applies to Small & Regular Subscribers)

Bug fixes:

  • Fix bug where certain users were unable to export their dinger setups
  • Fix 500 error when "hasServices" filter was used on the GET /api/1/services endpoint
  • Fix bug where dinger projected cost was not returning a value under certain conditions
  • Fix 500 error when using endpoint /api/1/paper-filing

June 2024

API version 1.1024.0

Changes or new features:

  • Update GET /api/1/cns-reports/settings to only return data for the effective date - use effectiveActiveTo column to filter out ones that are not active (effectiveActiveTo is the date until which a service will continue to be active until)
  • Create an "include full text" flag for dingers - by default it is set to false, and has to be explicitly set for dinger queries that do not specify a field to search the full text field as well (this is for the upcoming feature that will allow the OCR'd text of complaints to be searched) 
  • Update GET endpoint for nationwide subscriptions (applies to Small & Regular subscribers only)

Bug fixes:

  • Fixed an issue where you were unable to add new recipients to a report due to full name exceeding character limits

 

May 2024

API version 1.978.0

Changes or new features:

  • Create endpoint for retrieving the current order of courts from some civil service: GET /api/1/services/{serviceId}/court-order returns an array of case block ids in the order they were in the last report.

Bug fixes:

  • Fixed an issue where you could not add a service subscription when the same service is inactive

 

April 2024

API version 1.904.0

Changes or new features:

  • Create endpoint for retrieving nationwide dingers: GET /api/1/dingers/nationwide
  • Update POST endpoint for tracking changes: Updated to return tracking changes more efficiently.
  • Allow users to edit report recipient list: Users can now update the recipient list via the API.
  • Update My Downloads endpoint: Include property that indicates where the purchase was made (web app or iOS).

 

February 2024

API version 1.858.0

Changes or new features:

  • Created new API endpoint GET /api/1/firms/activity for retrieving usage statistics by Office or Firm.

API version 1.856.0

Changes or new features:

  • When a user submits a document request form in the app, they will now receive an autoreply email in addition to the in-app "thank you" message.

Bug fixes:

  • Fixed an issue where some reports for 2/13 were not syncing correctly and appearing in CasePortal despite being distributed from CNS Plus. The underlying cause has been resolved.

  • Fixed an issue where page size limit of 100 was not being applied correctly to search endpoints

API version 1.842.0

Changes or new features:

  • Created new endpoint GET /api/2/trackers/export to support exporting trackers from the UI to Excel. Includes various filtering options.

API version 1.838.0

Changes or new features:

  • When recording a dinger hit, information is now captured about why the hit happened, with highlighted text from Elasticsearch to provide context.

    • Dinger hits now show the case as it was at the time of the hit

  • Created batch PUT endpoint /api/1/trackers/{id}/batch/recipients for updating tracker recipients in bulk, similar to existing endpoint for dingers.

API version 1.826.0

Changes or new features:

  • Created property for offices to track account suspension status. Exposed this in the API. Behavior varies for Jumbo vs Small/Regular firms.

  • Disabled API access to ad hoc services that incur charges (trackers, dingers) when ad hoc services are suspended for an office due to non-payment.

API version 1.801.0

Bug fixes:

  • Fixed an issue where in some cases the aggregate counts reported in search were returning incorrect numbers

  • Fixed an issue where the docket sheet for some cases was not loading

December 2023

API version 1.764.0

Changes or new features:

  • Created a new endpoint POST /api/2/dinger/{id}/batch/recipient to add multiple recipients to a dinger in a single request.

  • Introduce API throttling for all endpoints based on Jumbo tier of customer

November 2023

API Version 1.718.0

Bug fixes:

  • Fixed a bug where plaintiff names were being truncated in some CNS Reports

API Version 1.706.0

Changes or new features:

  • Added ability to filter dinger results by keyword used in the query

  • When deleting a user, added option to transfer ownership of their dingers and trackers to another user of the same role or higher

API Version 1.712.0

Bug fixes:

  • Fixed a bug where the invoice history endpoint threw a 500 error when dates were provided with a time component

API Version 1.708.0

Changes or new features:

  • Created an API endpoint for exporting the dinger setups report to XLS or CSV - the export includes configurable fields that match the dinger setups grid in CasePortal UI

API Version 1.706.0

Bug fixes:

  • Fixed bankruptcy report history exports failing with 500 errors

  • Fixed a crash when trying to filter users export by fullName

October 2023

API Version 1.654.0

Changes or new features:

  • Implemented a 30 court limit when creating custom reports via the API.

API Version 1.635.2

Bug fixes

  • Fixed an issue where certain firms were unable to get the collection of trackers

API Version 1.635.0

Changes or new features:

  • Added City and State fields to the response for Case Blocks and Courts

  • Updated case title formatting:

    • Case titles displayed in the CasePortal app, dingers, and tracker emails will now be truncated to "Plaintiff v Defendant 1, Defendant 2, Defendant 3, et al."

    • This change applies to all API endpoints except for CNS Reports and Custom Reports, which will continue to list all defendants in the title.

September 2023

API Version 1.597.0

Changes or new features:

  • Implemented an endpoint to re-send a Custom Report to all or individual recipients - functionality matches the equivalent CNS Reports endpoint

API Version 1.608.0

Changes or new features:

  • Created API endpoint for downloading or viewing an invoice as an embedded PDF

API Version 1.592.0

Changes or new features:

  • Created a proxy API endpoint for querying invoices - allows searching by time range and invoice number

API Version 1.567.0

Changes or new features:

  • Implemented an endpoint for retrieving the list of cases contained within a Custom Report - functionality matches the CNS Reports equivalent endpoint

August 2023

API Version 1.537.0

Changes or new features:

  • Implemented redirection for CivilLawsuit when the ID has changed due to reprocessing

API Version 1.523.0

Changes or new features:

  • Added opinions and bankruptcy downloads to the "My Downloads" history endpoint

API Version 1.525.0

Changes or new features:

  • Added case count to the services endpoint

  • Added an isCovered flag to services to indicate whether it's a real service, even if inactive

Bug fixes:

  • Fixed a validation error when filtering by isCovered

July 2023

API Version 1.525.0

  • Added bankruptcy charges and files to the billings report endpoint

  • Added libraryType attribute across all endpoints in the Global API for clarity

    • Replaced the serviceType attribute with libraryType to accurately represent the library of the service (e.g., "Opinions", "Civil Litigation", "Bankruptcies").

  • Changed attributes for petitioner to debtor in the API and SendGrid models - renamed the petitioner attribute to debtor to align with the correct terminology.

API Version 1.489.0

Changes or new features:

  • Created Reports API endpoint for dinger setups with filters for date range, user, user group, and office ID.

  • Created Reports API endpoint for tracker runs with filters for date range, user, user group, and office ID.

API Version 1.467.0

Changes or new features:

  • Updated API to include summary results of dinger counts

API Version 1.469.0

Bug fixes:

  • Fixed an issue where CasePortal was showing duplicate complaint files in some cases

API Version 1.461.0

Breaking changes:

  • Bankruptcy library

    • field "Petitioner" has been universally changed to "Debtor"

    • values have also been updated for filters

Changes or new features:

  • Introduced a caseType field to the Civil Litigation library to differentiate between regular Civil Litigation cases and Adversary Proceedings

June 2023

API version 1.429.0

Breaking changes:

  • New required parameter reportName in /api/1/cns-reports/hits/{reportId}/cases/export

  • Removed GET/PATCH /api/1/firms/{firmId}/firm-billing-office endpoint

  • Removed GET/POST /api/1/billing/cycles/{officeId} endpoint

  • Re POST /api/1/offices

    • Added new parts to model:

      • billingInfo

      • activationDateUtc

      • billingCycle

      • isPricingPlanOffice

      • paysForAllAdHocCharges

  • Re GET api/1/firms

    • no longer returns:

      • firmBillingOfficeId

      • isFirmBillingOfficePayAdHocChanges

      • firmBillingOfficeName

Changes or new features:

  • PUT /api/1/offices/{officeId}

    • removed firmId (you are not able to change office location - to another firm - so the parameter is not needed)

  • PUT /api/1/firms/{firmId}

    • removed firmBillingOfficeId from input model

    • removed isFirmBillingOfficePayAdHocChanges from input model

  • POST /api/1/firms

    • removed isFirmBillingOfficePayAdHocChanges from input model

  • GET /api/1/offices/{firmId}

    • returns new fields:

      • activationDateUtc

      • billingCycle

      • paysForAllAdHocCharges

      • billingInfo

  • POST api/1/firms

    • no longer requires the following attributes:

      • firmBillingOfficeId

      • isFirmBillingOfficePayAdHocChanges

      • firmBillingOfficeName