Articles in this section

See more

Changes to Documents API endpoint

Avatar
Jonas Caruana
  • Updated

Objective

  • Changes to Documents API endpoint
  • New Documents Versions API endpoint

Environment

  • Clio API

Additional information

To enhance site performance, we have limited the number of results returned by the `document_versions` field on Documents endpoints to include only the latest 200 versions of a document instead of all versions. 

Effective immediately, we are exposing a new Document Versions endpoint to allow full access to the complete document version history. This new endpoint is live as of January 27, 2021. We intend to deprecate the usage of the `document_versions` collection in the Documents endpoints on March 1, 2021. 

Required actions

  • Migrate document version functionality to use the new  /api/v4/documents/:document_id/versions endpoint by March 1, 2021.
  • Once your code is fully migrated to the new Documents Versions endpoint and no longer uses the `document_version` field on Documents endpoints, you can confirm your new code will work on March 1st by setting the `X-API-VERSION` to `4.0.6`.
  • On March 1st, minor version 4.0.6 will be promoted to the current version and requests for the `document_versions` field on Documents endpoints will return a `400 Bad Request` error with a payload of `{"error":{"type":"InvalidFields","message":"document_versions is not a valid field"}}`.

Impacted endpoints

(Only for the document_versions return field):

  • GET /api/v4/documents
  • POST /api/v4/documents
  • GET /api/v4/documents/:document_id
  • PATCH /api/v4/documents/:document_id

Developer support

If you have any questions or concerns, please email api@clio.com