---
title: "Get images for a given project iteration or workspace."
method: GET
path: "/projects/{projectId}/images"
tags: ["ImageApi"]
---

# Get images for a given project iteration or workspace.

`GET /projects/{projectId}/images`

This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and
"Cat" tags, then only images tagged with Dog and/or Cat will be returned

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `iterationId` string, uuid
- `tagIds` string[]
- `taggingStatus` 'All' | 'Tagged' | 'Untagged'
- `$filter` string
- `orderBy` 'Newest' | 'Oldest'
- `take` integer
- `skip` integer

## Response `200`

OK

- Image[]
  - `id` string, uuid — Id of the image.
  - `created` string, date-time — Date the image was created.
  - `width` integer — Width of the image.
  - `height` integer — Height of the image.
  - `resizedImageUri` string — The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
  - `thumbnailUri` string — The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
  - `originalImageUri` string — The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
  - `tags` ImageTag[], nullable — Tags associated with this image.
    - `tagId` string, uuid
    - `tagName` string
    - `created` string, date-time
  - `regions` ImageRegion[], nullable — Regions associated with this image.
    - `regionId` string, uuid
    - `tagName` string
    - `created` string, date-time
    - `tagId` string, uuid, required — Id of the tag associated with this region.
    - `left` number, float, required — Coordinate of the left boundary.
    - `top` number, float, required — Coordinate of the top boundary.
    - `width` number, float, required — Width.
    - `height` number, float, required — Height.
  - `metadata` object, nullable — Metadata associated with this image.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/azure/apis/cognitiveservices-customvision-training.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-customvision-training/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-customvision-training/versions/82dfb72c78fa/schema)