Skip to content

PeopleListItemDto

Endpoints · All schemas

FieldRequiredDescription
assetCountYesNumber of timeline assets showing this person
birthDateYesPerson date of birth
colorNoPerson color (hex)
featuredAssetIdNoThe photo the person's featured face is in (). Returned only to the person's owner, by GET and PUT /people/:id; null when there is none, when it is another account's photo, or when it may not be shown (trashed, hidden, Locked, a removed or invisible face, or hidden as NSFW)
idYesPerson ID
isFavoriteNoIs favorite
isHiddenYesIs hidden
lastSeenAtYesCapture date of the most recent timeline asset showing this person
nameYesPerson name
thumbnailPathYesThumbnail path
updatedAtNoLast update date

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "assetCount": {
      "description": "Number of timeline assets showing this person",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "birthDate": {
      "description": "Person date of birth",
      "format": "date",
      "nullable": true,
      "type": "string"
    },
    "color": {
      "description": "Person color (hex)",
      "type": "string"
    },
    "featuredAssetId": {
      "description": "The photo the person's featured face is in (). Returned only to the person's owner, by GET and PUT /people/:id; null when there is none, when it is another account's photo, or when it may not be shown (trashed, hidden, Locked, a removed or invisible face, or hidden as NSFW)",
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "id": {
      "description": "Person ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "isFavorite": {
      "description": "Is favorite",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Is hidden",
      "type": "boolean"
    },
    "lastSeenAt": {
      "description": "Capture date of the most recent timeline asset showing this person",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "name": {
      "description": "Person name",
      "type": "string"
    },
    "thumbnailPath": {
      "description": "Thumbnail path",
      "type": "string"
    },
    "updatedAt": {
      "description": "Last update date",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assetCount",
    "birthDate",
    "id",
    "isHidden",
    "lastSeenAt",
    "name",
    "thumbnailPath"
  ],
  "type": "object"
}