Skip to main content
By default, the Lucca API responds with the JSON representation of the requested resource, nothing more. But you may request for complementary includes, such as:
You can retrieve multiple types of includes by chaining the query parameter values: ?include=totalCount,embedded,links.
Access rights are evaluated when including embedded resources, thus you may not systematically retrieve them even when including them.

​
About Embedded

When adding ?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:
  • Embedded resources may not actually be included in responses if you do not have access to them.
  • The included representation may be partial, i.e. only give you a subset of the resource properties.
  • It may also be stale from cache in the very short term.
  • You cannot choose which resources to embed. The list of available resources is dictated by each API endpoint. Including embedded resource is a binary affair: do include them, or do not.
In order to avoid duplicates, embedded resources representations are formatted as a double-level dictionary: indexed by resource type (e.g. leave, employee, etc…) then by id.
Links are objects that represent navigational references to other resources and/or actions on the target resource. Examples are:
  • links to the previous and next pages of a collection.
  • link to the approval process of a leave-request.
These can be used to reduce coupling between the client and server implementations, as well as to predict access: the next page link will be null whenever there’s no next page, the link to the approval process will be null whenever the leave-request is already approved or you have insufficient rights to approve it. By default, links are omitted from responses, but may be included through the include query parameter.