> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/products/special-images/list-special-images.md).

# List special images

Returns a paginated list of special images. Use the query parameters to filter by image type or by the underlying product image, and to page and order the results.

```json
{"openapi":"3.1.0","info":{"title":"Admin API","version":"1.0.0"},"tags":[{"name":"Special Images","description":"Administrative endpoints for **special images** — the association that flags one of a product's images as serving a specific purpose (base, swatch, listing, or picto). A special image points at an existing product image and marks the role that image plays; it does not upload or store the image itself.\n\n## Core Capabilities\n\n**1. Special Image Listing & Filtering**\n* Retrieve a paginated list of special images.\n* Filter by image type and by the underlying product image.\n\n**2. Special Image Lifecycle Management**\n* Assign an image role to a product (create), replacing any image previously holding that role for the same product.\n* Retrieve, replace (PUT), partially update (PATCH), or delete a single special image.\n\n## Image Types\n\nThe `image_type` field selects the role the image plays. Each `(product, image_type)` pair is unique: a product can hold at most one image of each type.\n\n| Value | Description |\n|-------|-------------|\n| `base` | The product's primary/base image. |\n| `swatch` | A color or material swatch image. |\n| `listing` | The image used in product listings. |\n| `picto` | A pictogram / icon image. |\n\nBecause the type is unique per product, **creating or updating** a special image is effectively an upsert: any existing record with the same `product` and `image_type` is removed first, so a new assignment always replaces the previous one and no duplicate or orphan row is left behind.\n\n## Dynamic Settings & Environment Variables\n\nNo dynamic settings (`dj_dynamic_settings`) and no environment variables affect these endpoints. Listing, creation, update, and deletion behave identically regardless of management-panel configuration."}],"servers":[{"description":"Omnitron Remote Proxy (external access — recommended)","url":"https://{omnitron_url}/api/v1/remote/{channel_id}","variables":{"omnitron_url":{"default":"sandbox.akinon.com","description":"Omnitron server URL (e.g., {omnitron.akinon.com})"},"channel_id":{"default":"1","description":"The channel identifier the remote request is routed through"}}},{"description":"Commerce API Server (internal / direct access only)","url":"https://{commerce_url}/api/v1","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Internal commerce server URL, reachable only from within the Omnitron network"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token credential sent in the Authorization header, in the form: `Token <your-token>`. Requires a staff (admin) account."}},"parameters":{"page":{"name":"page","in":"query","required":false,"description":"The page number to return.","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"The number of items to return per page.","schema":{"type":"integer","default":10}},"sort":{"name":"sort","in":"query","required":false,"description":"Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (`-`) for descending order.","schema":{"type":"string"}}},"schemas":{"SpecialImageType":{"type":"string","description":"The role a special image plays for its product. Each type is unique per product.\n* `base` — the product's primary/base image\n* `swatch` — a color or material swatch image\n* `listing` — the image used in product listings\n* `picto` — a pictogram / icon image","enum":["base","swatch","listing","picto"]},"PaginatedSpecialImageList":{"type":"object","description":"A paginated list of special images.","properties":{"count":{"type":"integer","description":"Total number of special images."},"next":{"type":["string","null"],"format":"uri","description":"URL of the next page, or `null` if this is the last page."},"previous":{"type":["string","null"],"format":"uri","description":"URL of the previous page, or `null` if this is the first page."},"results":{"type":"array","description":"The special images on the current page.","items":{"$ref":"#/components/schemas/SpecialImage"}}}},"SpecialImage":{"type":"object","description":"A special image record — marks one of a product's images with a specific role.","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the special image."},"product":{"type":"integer","description":"Identifier of the product the image belongs to."},"product_image":{"type":"integer","description":"Identifier of the underlying product image that is being flagged."},"image_type":{"$ref":"#/components/schemas/SpecialImageType"}},"required":["pk","product","product_image","image_type"]},"Error":{"type":"object","description":"An error response.","properties":{"detail":{"type":"string","description":"A human-readable description of the error."}},"additionalProperties":true}},"responses":{"Unauthorized":{"description":"Authentication credentials were not provided or are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The authenticated user does not have administrator privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/special_image/":{"get":{"tags":["Special Images"],"operationId":"listSpecialImages","summary":"List special images","description":"Returns a paginated list of special images. Use the query parameters to filter by image type or by the underlying product image, and to page and order the results.","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"name":"image_type","in":"query","required":false,"description":"Filter by image role.","schema":{"$ref":"#/components/schemas/SpecialImageType"}},{"name":"product_image","in":"query","required":false,"description":"Filter by the identifier of the underlying product image.","schema":{"type":"integer"}}],"responses":{"200":{"description":"A paginated list of special images.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSpecialImageList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/products/special-images/list-special-images.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
