New Features

CRCLA V2.0 introduces several improvements designed to make the API faster and more scalable.

Key Highlights

  • Improved Performance: Endpoints now return lighter responses by moving large related datasets to paginated URLs.

  • Versioning: All v2.0 endpoints are available under the /api/v2/ namespace.

  • Hyperlinked Relationships: Instead of embedding large nested arrays, related records are now referenced by hyperlinks you can query separately.


To speed up queries and improve response times, three fields that previously returned all records inline have been updated to provide paginated URLs instead.

Field
Type
Documentation Link

case_documents_url

string (URL)

case_dockets_url

string (URL)

case_resources_url

string (URL)

These fields now return a link you can follow to retrieve related records in a paginated format.

To learn more about pagination behavior, see Pagination.

Removed Fields

As part of this change, a few fields that previously contained large serialized data has been removed and replaced by the URL fields listed above:

  • case_documents

  • case_dockets

  • case_resources

If your integration relied on these fields, you will now need to follow the corresponding URL to retrieve related records.


In addition to using the *_url fields returned in each Case object, you can also query related records directly by filtering on the case parameter.

This allows you to retrieve all related resources for a case without relying only on hyperlinks.

Examples

  • Retrieve all resources for a specific case: /api/v2/resources/?case=15150

  • Retrieve all documents for a specific case: /api/v2/documents/?case=15150

  • Retrieve all dockets for a specific case: /api/v2/dockets/?case=15150

To learn more about query behavior, see Query Behavior.

Last updated