API versioning
Set the version with the Nex-Api-Version header. The current stable version is v3.0.0. Every request must include this header.
HeadersNex-Api-Version: v3.0.0
v3.0.0 and v20240412 are the same version
NexHealth first published v3.0.0 under the date-based name v20240412. You may still see that name in older material. The two names mean the same version. The Nex-Api-Version header accepts either value and both behave the same. If your integration already sends Nex-Api-Version: v20240412, you do not need to change anything.
v3.1.0 is the beta version
v3.1.0 is the edge version of the API. The endpoints that exist only in v3.1.0 are documented in this reference under NexHealth API v3.1.0 (Beta). Everything else behaves exactly like v3.0.0: a request sent with Nex-Api-Version: v3.1.0 uses v3.1.0 behavior where an endpoint is redefined there and falls through to v3.0.0 everywhere else. Access to v3.1.0 is limited to approved partner institutions. Contact NexHealth before you build on it.