Schema — OPTIONAL |
---|
album object — OPTIONALalbumName string | albumThumbnailAssetId string | albumUsers object[]role stringPossible values: [editor , viewer ] | user objectavatarColor stringPossible values: [primary , pink , red , yellow , blue , green , purple , orange , gray , amber ] | email string | id string | name string | profileChangedAt date-time | profileImagePath string |
|
| assetCount integer | assets object[]checksum string | deviceAssetId string | deviceId string | duplicateId string — OPTIONAL | duration string | exifInfo object — OPTIONALcity string — OPTIONAL | country string — OPTIONAL | dateTimeOriginal date-time — OPTIONAL | description string — OPTIONAL | exifImageHeight number — OPTIONAL | exifImageWidth number — OPTIONAL | exposureTime string — OPTIONAL | fNumber number — OPTIONAL | fileSizeInByte int64 — OPTIONAL | focalLength number — OPTIONAL | iso number — OPTIONAL | latitude number — OPTIONAL | lensModel string — OPTIONAL | longitude number — OPTIONAL | make string — OPTIONAL | model string — OPTIONAL | modifyDate date-time — OPTIONAL | orientation string — OPTIONAL | projectionType string — OPTIONAL | rating number — OPTIONAL | state string — OPTIONAL | timeZone string — OPTIONAL |
| fileCreatedAt date-time | fileModifiedAt date-time | hasMetadata boolean | id string | isArchived boolean | isFavorite boolean | isOffline boolean | isTrashed boolean | libraryId string — OPTIONALThis property was deprecated in v1.106.0 | livePhotoVideoId string — OPTIONAL | localDateTime date-time | originalFileName string | originalMimeType string — OPTIONAL | originalPath string | owner object — OPTIONALavatarColor stringPossible values: [primary , pink , red , yellow , blue , green , purple , orange , gray , amber ] | email string | id string | name string | profileChangedAt date-time | profileImagePath string |
| ownerId string | people object[] — OPTIONALbirthDate date | faces object[]boundingBoxX1 integer | boundingBoxX2 integer | boundingBoxY1 integer | boundingBoxY2 integer | id uuid | imageHeight integer | imageWidth integer | sourceType string — OPTIONALPossible values: [machine-learning , exif ] |
| id string | isHidden boolean | name string | thumbnailPath string | updatedAt date-time — OPTIONALThis property was added in v1.107.0 |
| resized boolean — OPTIONALThis property was deprecated in v1.113.0 | smartInfo object — OPTIONALobjects string[] — OPTIONAL | tags string[] — OPTIONAL |
| stack object — OPTIONALassetCount integer | id string | primaryAssetId string |
| tags object[] — OPTIONALcolor string — OPTIONAL | createdAt date-time | id string | name string | parentId string — OPTIONAL | updatedAt date-time | value string |
| thumbhash string | type stringPossible values: [IMAGE , VIDEO , AUDIO , OTHER ] | unassignedFaces object[] — OPTIONALboundingBoxX1 integer | boundingBoxX2 integer | boundingBoxY1 integer | boundingBoxY2 integer | id uuid | imageHeight integer | imageWidth integer | sourceType string — OPTIONALPossible values: [machine-learning , exif ] |
| updatedAt date-time |
| createdAt date-time | description string | endDate date-time — OPTIONAL | hasSharedLink boolean | id string | isActivityEnabled boolean | lastModifiedAssetTimestamp date-time — OPTIONAL | order string — OPTIONALPossible values: [asc , desc ] | owner objectavatarColor stringPossible values: [primary , pink , red , yellow , blue , green , purple , orange , gray , amber ] | email string | id string | name string | profileChangedAt date-time | profileImagePath string |
| ownerId string | shared boolean | startDate date-time — OPTIONAL | updatedAt date-time |
| allowDownload boolean | allowUpload boolean | assets object[]checksum string | deviceAssetId string | deviceId string | duplicateId string — OPTIONAL | duration string | exifInfo object — OPTIONALcity string — OPTIONAL | country string — OPTIONAL | dateTimeOriginal date-time — OPTIONAL | description string — OPTIONAL | exifImageHeight number — OPTIONAL | exifImageWidth number — OPTIONAL | exposureTime string — OPTIONAL | fNumber number — OPTIONAL | fileSizeInByte int64 — OPTIONAL | focalLength number — OPTIONAL | iso number — OPTIONAL | latitude number — OPTIONAL | lensModel string — OPTIONAL | longitude number — OPTIONAL | make string — OPTIONAL | model string — OPTIONAL | modifyDate date-time — OPTIONAL | orientation string — OPTIONAL | projectionType string — OPTIONAL | rating number — OPTIONAL | state string — OPTIONAL | timeZone string — OPTIONAL |
| fileCreatedAt date-time | fileModifiedAt date-time | hasMetadata boolean | id string | isArchived boolean | isFavorite boolean | isOffline boolean | isTrashed boolean | libraryId string — OPTIONALThis property was deprecated in v1.106.0 | livePhotoVideoId string — OPTIONAL | localDateTime date-time | originalFileName string | originalMimeType string — OPTIONAL | originalPath string | owner object — OPTIONALavatarColor stringPossible values: [primary , pink , red , yellow , blue , green , purple , orange , gray , amber ] | email string | id string | name string | profileChangedAt date-time | profileImagePath string |
| ownerId string | people object[] — OPTIONALbirthDate date | faces object[]boundingBoxX1 integer | boundingBoxX2 integer | boundingBoxY1 integer | boundingBoxY2 integer | id uuid | imageHeight integer | imageWidth integer | sourceType string — OPTIONALPossible values: [machine-learning , exif ] |
| id string | isHidden boolean | name string | thumbnailPath string | updatedAt date-time — OPTIONALThis property was added in v1.107.0 |
| resized boolean — OPTIONALThis property was deprecated in v1.113.0 | smartInfo object — OPTIONALobjects string[] — OPTIONAL | tags string[] — OPTIONAL |
| stack object — OPTIONALassetCount integer | id string | primaryAssetId string |
| tags object[] — OPTIONALcolor string — OPTIONAL | createdAt date-time | id string | name string | parentId string — OPTIONAL | updatedAt date-time | value string |
| thumbhash string | type stringPossible values: [IMAGE , VIDEO , AUDIO , OTHER ] | unassignedFaces object[] — OPTIONALboundingBoxX1 integer | boundingBoxX2 integer | boundingBoxY1 integer | boundingBoxY2 integer | id uuid | imageHeight integer | imageWidth integer | sourceType string — OPTIONALPossible values: [machine-learning , exif ] |
| updatedAt date-time |
| createdAt date-time | description string | expiresAt date-time | id string | key string | password string | showMetadata boolean | token string — OPTIONAL | type stringPossible values: [ALBUM , INDIVIDUAL ] | userId string |
|