---
title: "Get property images metadata"
method: GET
path: "/listing/property/{propertyId}/images"
tags: ["Listing"]
---

# Get property images metadata

`GET /listing/property/{propertyId}/images`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/listing/property/{propertyId}/images`
- Auth: `appAuth` (a scheme the document does not define)

Get image metadata for a property listing

## Path parameters

- `propertyId` integer, required

## Headers

- `x-Image-Client` string
- `AgencyRef` string, required

## Response `200`

Returns the image metadata for a property listing

- ListingImagesResponse
  - `galleryImages` ListingImageResponse[], nullable
    - `id` integer: The media id of the image.
    - `order` integer: The web display order of the image.
    - `main` boolean: True for the first gallery image.
    - `caption` string, nullable: The image caption.
    - `modifiedDate` string, date-time: The date and time the image was last modified.
    - `sizes` ListingSizesResponse: The URLs of each available size of a listing image.
      - `screen` ListingImageDetailResponse
        - `src` string, nullable
      - `thumbnail` ListingImageDetailResponse
        - `src` string, nullable
      - `tile` ListingImageDetailResponse
        - `src` string, nullable
      - `banner` ListingImageDetailResponse
        - `src` string, nullable
      - `print` ListingImageDetailResponse
        - `src` string, nullable
  - `virtualTourImages` ListingVirtualTourImageResponse[], nullable
    - `id` integer: The media id of the image.
    - `order` integer: The web display order of the image.
    - `main` boolean: True for the first gallery image.
    - `caption` string, nullable: The image caption.
    - `modifiedDate` string, date-time: The date and time the image was last modified.
    - `sizes` ListingSizesResponse: The URLs of each available size of a listing image.
      - `screen` ListingImageDetailResponse
        - `src` string, nullable
      - `thumbnail` ListingImageDetailResponse
        - `src` string, nullable
      - `tile` ListingImageDetailResponse
        - `src` string, nullable
      - `banner` ListingImageDetailResponse
        - `src` string, nullable
      - `print` ListingImageDetailResponse
        - `src` string, nullable
    - `src` string, nullable: The URL of the stored virtual tour image.
  - `virtualTourLinks` ListingLinkResponse[], nullable
    - `id` integer: The media id of the link.
    - `order` integer: The web display order of the link.
    - `description` string, nullable: The link caption.
    - `url` string, nullable: The external URL of the link.
    - `modifiedDate` string, date-time: The date and time the link was last modified.
  - `floorplanImages` ListingImageResponse[], nullable
    - `id` integer: The media id of the image.
    - `order` integer: The web display order of the image.
    - `main` boolean: True for the first gallery image.
    - `caption` string, nullable: The image caption.
    - `modifiedDate` string, date-time: The date and time the image was last modified.
    - `sizes` ListingSizesResponse: The URLs of each available size of a listing image.
      - `screen` ListingImageDetailResponse
        - `src` string, nullable
      - `thumbnail` ListingImageDetailResponse
        - `src` string, nullable
      - `tile` ListingImageDetailResponse
        - `src` string, nullable
      - `banner` ListingImageDetailResponse
        - `src` string, nullable
      - `print` ListingImageDetailResponse
        - `src` string, nullable
  - `webLinks` ListingLinkResponse[], nullable
    - `id` integer: The media id of the link.
    - `order` integer: The web display order of the link.
    - `description` string, nullable: The link caption.
    - `url` string, nullable: The external URL of the link.
    - `modifiedDate` string, date-time: The date and time the link was last modified.
  - `externalBrochures` ListingBrochureResponse[], nullable
    - `id` integer: The media id of the brochure.
    - `description` string, nullable: The brochure caption.
    - `url` string, nullable: The URL of the brochure file.
    - `modifiedDate` string, date-time: The date and time the brochure was last modified.
    - `defaultPropertyBrochure` boolean: True when this is the default brochure for the property.

## Other responses

- `400`: When the request does not contain the expected information
- `401`: When access has not been granted

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)