Get a List of Product Images v 3.0 catalog.product.image.list

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: catalog

Who can execute the method: a user with the "View product catalog", "View catalog products", or "Edit selling price" permission

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.product.image.list method returns the images of one product or variation.

Method Parameters

Required parameters are marked with *

Name `type`	Description
filter* `array`	A filter in REST 3.0 format: an array of conditions in the form `["field", "operator", "value"]`. The filter syntax is described in the REST 3.0 overview. The filter must contain a condition on `productId` with the `=` operator, for example `[["productId","=",7537]]`. The method does not support other fields and operators. The product identifier can be retrieved using the catalog.product.list method, the variation identifier — using the catalog.product.offer.list method
select `array`	A list of image fields to return in the response. Available fields: `id` — image identifier `productId` — product or variation identifier `type` — image type `name` — file name `createTime` — file upload date and time `detailUrl` — view link `downloadUrl` — download link Default: all fields. An empty array `[]` also returns all fields
pagination `object`	Pagination. Object description

Sorting with order is not supported. Images are returned in this order: preview picture, detail picture, additional pictures.

Parameter pagination

Name `type`	Description
limit `integer`	The number of images per page. The value `0` causes an error. Default: `50`
page `integer`	Page number, starting from `1`
offset `integer`	The number of images to skip

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.product.image.list

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["productId","=",7537]]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.image.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[["productId","=",7537]],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.image.list

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ProductImageListResult = {
          items: Array<{
            id: number
            productId: number
            type: 'PREVIEW_PICTURE' | 'DETAIL_PICTURE' | 'MORE_PHOTO'
            name: string
            createTime: ISODate
            detailUrl: string
            downloadUrl: string
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ProductImageListResult>({
            method: 'catalog.product.image.list',
            params: {
              filter: [
                ['productId', '=', 7537],
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            result.items.forEach(image => console.info(image.id, image.type, image.detailUrl))
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listProductImages() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.image.list',
                params: {
                  filter: [
                    ['productId', '=', 7537],
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              result.items.forEach(image => console.info(image.id, image.type, image.detailUrl))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listProductImages)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.image.list(
                filter=[
                    ["productId", "=", 7537],
                ],
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.image.list',
                    [
                        'filter' => [
                            ['productId', '=', 7537],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.product.image.list',
            {
                filter: [
                    ['productId', '=', 7537],
                ],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.image.list',
            [
                'filter' => [
                    ['productId', '=', 7537],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.product.image.list", b24.Params{
        	"filter": []any{
        		[]any{"productId", "=", 7537},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.product.image.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		ID        int    `json:"id"`
        		Type      string `json:"type"`
        		Name      string `json:"name"`
        		DetailURL string `json:"detailUrl"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, image := range result.Items {
        	fmt.Println(image.ID, image.Type, image.DetailURL)
        }

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 39443,
                        "productId": 7537,
                        "type": "PREVIEW_PICTURE",
                        "name": "preview.png",
                        "createTime": "2026-10-22T12:14:32+02:00",
                        "detailUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png",
                        "downloadUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png"
                    },
                    {
                        "id": 39447,
                        "productId": 7537,
                        "type": "DETAIL_PICTURE",
                        "name": "red2.png",
                        "createTime": "2026-10-22T12:14:34+02:00",
                        "detailUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png",
                        "downloadUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png"
                    },
                    {
                        "id": 39439,
                        "productId": 7537,
                        "type": "MORE_PHOTO",
                        "name": "more.png",
                        "createTime": "2026-10-22T12:14:20+02:00",
                        "detailUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png",
                        "downloadUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png"
                    },
                    {
                        "id": 39451,
                        "productId": 7537,
                        "type": "MORE_PHOTO",
                        "name": "photo.png",
                        "createTime": "2026-10-22T12:15:59+02:00",
                        "detailUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png",
                        "downloadUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png"
                    }
                ]
            },
            "time": {
                "start": 1792660562,
                "finish": 1792660562.218583,
                "duration": 0.2185831069946289,
                "processing": 0,
                "date_start": "2026-10-22T12:16:02+02:00",
                "date_finish": "2026-10-22T12:16:02+02:00",
                "operating_reset_at": 1792661160,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Response data object
result.items `array`	An array of images. The set of fields depends on `select`. Field description
time `time`	Information about the request execution time

Items Element

Name `type`	Description
id `integer`	Image identifier. Matches the file identifier in Bitrix24
productId `integer`	Product or variation identifier
type `string`	Image type: `PREVIEW_PICTURE` — preview picture, `DETAIL_PICTURE` — detail picture, `MORE_PHOTO` — additional picture
name `string`	File name
createTime `datetime`	File upload date and time
detailUrl `string`	Link to view the image
downloadUrl `string`	Link to download the image

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
                "message": "Error validating request object filters.",
                "validation": [
                    {
                        "message": "Filter for required field \"productId\" is required.",
                        "field": "filter.productId"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Filter Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Field	Error description	How to Fix
`filter.productId`	Filter for required field `productId` is required	Pass the condition `["productId","=",<identifier>]` with the `=` operator in `filter`

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`filter`	Field value must not be empty	Pass `filter` with a condition on `productId`
`#FIELD#`	DTO `ProductImageDto` in field `#FIELD#` requires attribute `Filterable` to perform this request	Filter only by `productId`
`id`	DTO `ProductImageDto` in field `id` requires attribute `Sortable` to perform this request	Remove `order` from the request: sorting is not supported

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field	Error description	How to Fix
`pagination`	Incorrect `pagination` parameter value: `{"limit":0}`	Pass a number greater than `0` in `limit`

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`productId`	Entity with ID `#ID#` was not found	The product was not found or does not belong to the trade catalog. Check the identifier using the catalog.product.list method

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`select`	Unknown field `#FIELD#` found in entity `ProductImageDto`	Specify in `select` only the fields from the `select` parameter description

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions to view the catalog and to read the product in the information block

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Get a List of Product Images

Remove an Image from a Product

Get a List of Product Images v 3.0 catalog.product.image.list

Method ParametersMethod Parameters

Parameter paginationParameter pagination

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Items ElementItems Element

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Filter Validation ErrorsFilter Validation Errors

Request Validation ErrorsRequest Validation Errors

Pagination ErrorPagination Error

Object Not Found ErrorObject Not Found Error

Unknown Field ErrorUnknown Field Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter pagination

Code Examples

Response Handling

Returned Data

Items Element

Error Handling

Possible Error Codes

Filter Validation Errors

Request Validation Errors

Pagination Error

Object Not Found Error

Unknown Field Error

Access Error

Statuses and System Error Codes

Continue Learning