The portrait resource

{
  "id": "874",
  "type": "portrait",
  "url": "https://example.ilucca.net/lucca-api/portraits/874",
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "fileName": "jdoe-800.jpeg",
  "contentType": "image/jpeg",
  "links": {}
}

JSON representation of the image file that represents an employee.

You can also retrieve the actual image file through content negotiation: Accept: image/*.

string

Minimum string length: 1

type

string

Allowed value: "portrait"

url

string<uri>

employee

employee-reference · object

Reference to an employee resource.

Show child attributes

fileName

string

Minimum string length: 1

contentType

string

Examples may be: 'image/jpeg', 'image/png', 'image/bmp', 'image/gif', 'image/tiff', etc...

createdAt

string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

links

object

Retrieve an employee

Retrieve/Download a portrait

⌘I

Overview

Files

Organization

Employee Records

Events & Webhooks

The portrait resource