Get the list of product images catalog.productImage.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" or "View catalog products" permission and permission to read the product

The method catalog.productImage.list returns all images of a product, parent product, variation, or service in a single response, without pagination.

Method Parameters

Required parameters are marked with *

Name
type

Description

productId*
catalog_product.id|
catalog_product_sku.id|
catalog_product_offer.id|
catalog_product_service.id

Identifier of the product, parent product, variation, or service.

To obtain existing identifiers, use the following methods:

select
array

Array of fields to return:

  • id — image identifier
  • name — file name
  • productId — product identifier
  • type — image type
  • createTime — creation date
  • downloadUrl — download link
  • detailUrl — link to the image

Pass field names in camelCase, as in the list. The method skips unknown fields and names in a different case, for example ID, without an error.

If select is not passed, all fields are returned

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productImage.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.productImage.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type ProductImageListResult = {
          productImages: {
            id: number
            name: string
            productId: number
            type: 'DETAIL_PICTURE' | 'PREVIEW_PICTURE' | 'MORE_PHOTO'
            createTime: ISODate
            downloadUrl: string
            detailUrl: string
          }[]
        }
        
        try {
          // catalog.productImage.list returns all images of the product in one response, without pagination
          const response = await $b24.actions.v2.call.make<ProductImageListResult>({
            method: 'catalog.productImage.list',
            params: {
              productId: 1,
              select: [
                'id',
                'name',
                'productId',
                'type',
                'createTime',
                'downloadUrl',
                'detailUrl',
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Product images:', result.productImages, 'Count:', result.productImages.length)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listProductImages() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // catalog.productImage.list returns all images of the product in one response, without pagination
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.productImage.list',
                params: {
                  productId: 1,
                  select: [
                    'id',
                    'name',
                    'productId',
                    'type',
                    'createTime',
                    'downloadUrl',
                    'detailUrl',
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Product images:', result.productImages, 'Count:', result.productImages.length)
            } 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(
                product_id=1,
                select=[
                    "id",
                    "name",
                    "productId",
                    "type",
                    "createTime",
                    "downloadUrl",
                    "detailUrl",
                ],
                start=0,
            ).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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productImage.list',
                    [
                        'productId' => 1,
                        'select'    => [
                            'id',
                            'name',
                            'productId',
                            'type',
                            'createTime',
                            'downloadUrl',
                            'detailUrl',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing product images: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.productImage.list',
            {
                productId: 1,
                select: [
                    'id',
                    'name',
                    'productId',
                    'type',
                    'createTime',
                    'downloadUrl',
                    'detailUrl',
                ],
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
                result.next();
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productImage.list',
            [
                'productId' => 1,
                'select' => [
                    'id',
                    'name',
                    'productId',
                    'type',
                    'createTime',
                    'downloadUrl',
                    'detailUrl'
                ]
            ]
        );
        
        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.productImage.list", b24.Params{
        	"productId": 1,
        	"select":    []string{"id", "name", "productId", "type", "createTime", "downloadUrl", "detailUrl"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.productImage.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP status: 200

{
            "result": {
                "productImages": [
                    {
                        "createTime": "2023-08-21T12:12:19+03:00",
                        "detailUrl": "https:\/\/cdn-com.bitrix24.com\/b1234567\/iblock\/c3e\/c3e6943a5f28fb70dc0051fc74352d4f\/FTTH.jpg",
                        "downloadUrl": "https:\/\/your-domain.bitrix24.com\/rest\/1\/xxxxxxxxxxxxxxxx\/download\/?token=catalog%7CaWQ9MjI0MjEmXz1nYXc0RVlHaWo2cHJZTGNCS2VBa21lQTZkdVJwZ0tpNw%3D%3D%7C...",
                        "id": 22421,
                        "name": "FTTH.jpg",
                        "productId": 533,
                        "type": "MORE_PHOTO"
                    }
                ]
            },
            "total": 1,
            "time": {
                "start": 1793615807,
                "finish": 1793615807.756784,
                "duration": 0.7567839622497559,
                "processing": 0,
                "date_start": "2026-11-02T13:36:47+03:00",
                "date_finish": "2026-11-02T13:36:47+03:00",
                "operating_reset_at": 1793616360,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

result.productImages
catalog_product_image[]

Array of product images. If there are no images, an empty array is returned

total
integer

Number of product images

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "0",
            "error_description": "Product was not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

200040300010

Access Denied

The user does not have the "View product catalog" or "View catalog products" permission or permission to read the product

400

100

Could not find value for parameter

The required parameter productId is not passed

400

0

Empty productID

0 or a negative number is passed in productId

400

0

Product was not found

The product with the specified productId was not found

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 Exploring