Expand responses to retrieve more data.
Include type | Query | Description |
---|---|---|
Embedded | ?include=embedded | JSON representations of related resources. For example: the employee the requested leave object belongs to. |
Links | ?include=links | Links to related resources and/or actions. For example: links to the previous and next pages of a collection. |
Total count | ?include=totalCount | For collections, the total number of resources that satisfy the query filters across all pages. |
?include=totalCount,embedded,links
.?include=embedded
to your HTTP GET requests, the Lucca API will attempt to include the representations of related resource in the response. For example: you may retrieve the first and last name of the employee when retrieving his leaves.
Notes:
type
(e.g. leave
, employee
, etc…) then by id
.
include
query parameter.