Retrieve/Download a portrait
Retrieve a single employee portrait, either as a JSON representation, or the actual image file.
By default, the API returns a JSON representation. In order to download the image, you must send Accept: image/* HTTP request header.
Deprecated: download the portrait through the links.files["{id}"] entry of the employee, read with
?include=links, where {id} is the id of its portrait. Read more in Get Started With Files.
Access
Access
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Set the API version.
2024-11-01 "2024-11-01"10"2024-11-01"
Query Parameters
Include metadata:
embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links: links to related resources or actions (e.g. approving a leave-request). May benullwhen you do not have access to the resource (or action). Includes the download links of the files the resource references, underlinks.files.totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
embedded, links, totalCount Response
OK
JSON representation of the employee portrait.