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.
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Send image/*
if you want to download the file.
*/*
, application/json
, image/*
Path Parameters
Identifier of the portrait.
1
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 benull
when you do not have access to the resource (or action).totalCount
: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
Response
OK
JSON representation of the employee portrait. Embedded resources on an employee's portrait. JSON representation of the image file that represents an employee.
You can also retrieve the actual image file through content negotiation: Accept: image/*
.