Improved

API Changelog 7.28.1

Added

  • Enhanced document search results with a comprehensive set of new extra_fields, providing detailed metadata such as clm_metadata, completion_rate, various date fields, document_type, recipients, tags, and more. This allows for richer data retrieval and more granular analysis of search outcomes.

GET /public/beta/documents/search

  • added the optional property results/items/extra_fields/clm_metadata to the response with the 200 status
  • added the optional property results/items/extra_fields/completion_rate to the response with the 200 status
  • added the optional property results/items/extra_fields/date_completed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_expiration to the response with the 200 status
  • added the optional property results/items/extra_fields/date_expired to the response with the 200 status
  • added the optional property results/items/extra_fields/date_first_signed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_first_viewed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_last_signed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_last_viewed to the response with the 200 status
  • added the optional property results/items/extra_fields/date_modified to the response with the 200 status
  • added the optional property results/items/extra_fields/date_of_last_action to the response with the 200 status
  • added the optional property results/items/extra_fields/date_sent to the response with the 200 status
  • added the optional property results/items/extra_fields/document_type to the response with the 200 status
  • added the optional property results/items/extra_fields/effective_permissions to the response with the 200 status
  • added the optional property results/items/extra_fields/parent to the response with the 200 status
  • added the optional property results/items/extra_fields/path to the response with the 200 status
  • added the optional property results/items/extra_fields/recipient_count to the response with the 200 status
  • added the optional property results/items/extra_fields/recipients to the response with the 200 status
  • added the optional property results/items/extra_fields/removed to the response with the 200 status
  • added the optional property results/items/extra_fields/signed_count to the response with the 200 status
  • added the optional property results/items/extra_fields/tags to the response with the 200 status
  • added the optional property results/items/extra_fields/time_to_completion_hours to the response with the 200 status
  • added the optional property results/items/extra_fields/title to the response with the 200 status
  • added the optional property results/items/extra_fields/total to the response with the 200 status
  • added the optional property results/items/extra_fields/type to the response with the 200 status
  • added the optional property results/items/extra_fields/viewed_count to the response with the 200 status
  • added the optional property results/items/extra_fields/viewed_total_count to the response with the 200 status

Removed

  • Improved error response consistency by removing the redundant details property from 500 and 504 error responses, streamlining error handling.

GET /public/beta/documents/search

  • ⚠️ removed the required property details from the response with the 500 status
  • ⚠️ removed the required property details from the response with the 504 status