WARNING

Hyperlink serialization support will be deprecated in a future API release after September 30th, 2026. If your solution is still using the hyperlink URIs that were provided via API version 1.0, you will need to migrate your solution to parsing the record IDs and actualizing the API endpoint requests.

For the moment, you can still get hyperlinks returned by passing the use_hyperlinks=true query parameter with your request. For example, the following would return all cases with hyperlink URI references for associated records ( like entry_agent , household and others ) instead of the record ID:

/api/v1/cases?use_hyperlinks=true