gallery

ACCESS

Returned as child in:

model.galleries model.galleries

Example

{
  "id": 1,
  "name": "Portfolio",
  "description": null,
  "media_type": "image",
  "model_id": 1,
  "model_gallery_type_id": 1,
  "model_division_type_id": null,
  "office_id": null,
  "is_published": 0,
  "sort_order": 1,
  "created_at": "2025-01-31 12:00:00",
  "updated_at": "2025-01-31 12:00:00",
  "last_viewed_at": "2025-01-31 12:00:00",
  "url": "/portfolio",
  "model_division_name": null,
  "model_division_url": null,
  "office_name": null,
  "cover_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/small/[fileId].jpg?[cacheString]",
  "cover_small_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/small/[fileId].jpg?[cacheString]",
  "cover_medium_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/medium/[fileId].jpg?[cacheString]",
  "cover_large_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/large/[fileId].jpg?[cacheString]",
  "files": [{
    "id": 1,
    "model_gallery_id": 1,
    "external_id": null,
    "external_source": null,
    "ext": "png",
    "type": "image/png",
    "size": 1,
    "width": null,
    "height": null,
    "sort_order": 1,
    "credit": null,
    "user_id": 1,
    "is_processing": null,
    "created_at": "2025-01-31 12:00:00",
    "updated_at": "2025-01-31 12:00:00",
    "filename": "[fileId].jpg",
    "media_type": "image",
    "key": "[agencyId]/models/[modelId]/galleries/[galleryId]/[fileId].jpg",
    "url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/[fileId].jpg?[cacheString]",
    "small_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/small/[fileId].jpg?[cacheString]",
    "medium_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/medium/[fileId].jpg?[cacheString]",
    "large_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/galleries/[galleryId]/large/[fileId].jpg?[cacheString]",
    "aspect_ratio": 0.59,
    "is_landscape": null,
    "is_image": 0
  }]
}

Properties

id integer

name string

description string

media_type string

Media type — image, video or audio.

model_id integer

model_gallery_type_id integer

The ID of the gallery type, created in Settings > Types.

model_division_type_id integer

The ID of the assigned division type, created in Settings > Types. Null if the gallery has no division assignment.

office_id integer

is_published boolean

sort_order integer

created_at datetime

updated_at datetime

last_viewed_at datetime

url string

model_division_name string

model_division_url string

office_name string

cover_url string

Format: absolute-url

cover_small_url string

Format: absolute-url

cover_medium_url string

Format: absolute-url

cover_large_url string

Format: absolute-url

files array

id integer

model_gallery_id integer

external_id string

The Vimeo or YouTube ID of a linked video media item.

external_source string

For video media — vimeo or youtube.

ext string

type string

size integer

File size in bytes.

width integer

height integer

sort_order integer

credit string

The credit / caption added to the media item.

user_id integer

is_processing boolean

created_at datetime

updated_at datetime

filename string

media_type string

key string

url string

Format: absolute-url

The media item in its uploaded size and format. For example, rendering a gif or png image requires this property instead of a sized jpg transform.

small_url string

Format: absolute-url

A jpg image transformed based on the agency's Settings > Image Sizes configuration. If the media item is a video, this is the video thumbnail. Null for audio items.

medium_url string

Format: absolute-url

A jpg image transformed based on the agency's Settings > Image Sizes configuration. If the media item is a video, this is the video thumbnail. Null for audio items.

large_url string

Format: absolute-url

A jpg image transformed based on the agency's Settings > Image Sizes configuration. If the media item is a video, this is the video thumbnail. Null for audio items.

aspect_ratio number

is_landscape boolean

is_image boolean