---
title: "List Image Assets"
method: GET
path: "/api/v1/image-assets"
tags: ["Image Assets"]
---

# List Image Assets

`GET /api/v1/image-assets`

## Query parameters

- `perPage` integer
- `page` integer
- `imageType` 'banner' | 'logo' | 'thumbnail' | 'artwork' | 'secondaryLogo' | 'venueMap'
- `entityId` string

## Response `200`

Successful

- SerializedImageAssetsList
  - `data` SerializedImageAsset[]
    - `data` object
      - `id` string — ID of the image asset
      - `type` string — Resource type
      - `attributes` object
        - `name` string — Name of the image asset
        - `imageType` 'banner' | 'logo' | 'thumbnail' | 'artwork' | 'secondaryLogo' | 'venueMap' — Type of the image asset
        - `processingStatus` 'pending' | 'successful' | 'failed' — Current processing status of the image asset
        - `size` object
          - `width` integer — Width of the image asset
          - `height` integer — Height of the image asset
        - `entityId` string — UUID of the entity this image asset belongs to
        - `createdAt` string — Timestamp of when the image asset was created
        - `url` string — URL of the original image. This URL may change over time, so do not store or cache it. Always fetch the latest URL from the API when needed.
        - `watermark` object, nullable — Watermark configuration. Only present for banner image assets when watermarking is enabled
          - `color` 'dark' | 'light' — Watermark colour
          - `position` 'bottomLeft' | 'bottomRight' | 'topLeft' | 'topRight' — Watermark position on the image
  - `meta` IndexMeta
    - `totalCount` integer — Total count of records returned
    - `resultsPerPage` integer — Number of records returned per page. Set using the perPage query parameter.
    - `currentPage` integer — Index of current page
    - `totalPages` integer — Total pages returned
  - `links` IndexLinks
    - `first` string, nullable — Path to first page, null if currentPage is first page
    - `prev` string, nullable — Path to prev page, null if currentPage is first page
    - `next` string, nullable — Path to next page, null if currentPage is last page
    - `last` string, nullable — Path to last page, null if currentPage is last page

## Other responses

- `401` — Error: Unauthorized

---

[API](https://skmtc.dev/passentry/apis/passentry-api.md) · [All operations](https://skmtc.dev/passentry/apis/passentry-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/passentry/passentry-api/revisions/3b24e067f9d9/schema)