Linking & Embedding

Our API uses hyperlinks throughout to support easy discoverability and browsability, while also embedding related resources within a single response. Although not fully compliant with the entire HAL standard, it implements the _links and _embedded properties as described below.

Linking

The _links property in the response object provides links to other API resources, grouped by "relation." This relation defines how each linked resource connects back to the primary resource.

Embedding

To minimize HTTP requests, the response can optionally embed linked resources directly into the main response.

To include related resources under the _embedded key, add the _embedded query parameter to your request with a comma-separated list of the desired resources.

Linking#

Embedding#

Linking

Embedding