Get a List of Documents crm.documentgenerator.document.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","number","entityId","createTime"],"order":{"id":"desc"},"filter":{"entityTypeId":2,"entityId":101},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.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
        
        type DocumentItem = {
          id: string
          title: string
          number: string
          templateId: string
          entityTypeId: string
          entityId: string
          fileId: string
          imageId: string
          pdfId: string
          createTime: ISODate
          updateTime: ISODate
          createdBy: string | null
          updatedBy: string | null
          values: Record<string, unknown> | null
          downloadUrl: string
          imageUrl: string
          pdfUrl: string
          stampsEnabled: boolean
          downloadUrlMachine: string
          pdfUrlMachine: string
          imageUrlMachine: string
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DocumentListResult = {
          documents: DocumentItem[]
        }
        
        try {
          // crm.documentgenerator.document.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<DocumentListResult>({
            method: 'crm.documentgenerator.document.list',
            params: {
              select: ['id', 'title', 'number', 'entityId', 'createTime'],
              order: { id: 'desc' },
              filter: { entityTypeId: 2, entityId: 101 },
              start: 0,
            },
            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('Documents on this page:', result.documents.length, result.documents)
          }
        } 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 fetchDocumentList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.documentgenerator.document.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'crm.documentgenerator.document.list',
                params: {
                  select: ['id', 'title', 'number', 'entityId', 'createTime'],
                  order: { id: 'desc' },
                  filter: { entityTypeId: 2, entityId: 101 },
                  start: 0,
                },
                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('Documents on this page:', result.documents.length, result.documents)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchDocumentList)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.documentgenerator.document.list(
                select=["id", "title", "number", "entityId", "createTime"],
                order={"id": "desc"},
                filter={
                    "entityTypeId": 2,
                    "entityId": 101,
                },
                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}")
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.documentgenerator.document.list(
                select=["id", "title", "number", "entityId", "createTime"],
                order={"id": "desc"},
                filter={
                    "entityTypeId": 2,
                    "entityId": 101,
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        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}")
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.documentgenerator.document.list(
                select=["id", "title", "number", "entityId", "createTime"],
                order={"id": "desc"},
                filter={
                    "entityTypeId": 2,
                    "entityId": 101,
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        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(
                    'crm.documentgenerator.document.list',
                    [
                        'select' => ['id', 'title', 'number', 'entityId', 'createTime'],
                        'order' => ['id' => 'desc'],
                        'filter' => ['entityTypeId' => 2, 'entityId' => 101],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting documents list: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'crm.documentgenerator.document.list',
            {
                select: ['id', 'title', 'number', 'entityId', 'createTime'],
                order: { id: 'desc' },
                filter: { entityTypeId: 2, entityId: 101 },
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                console.info(result.data());
        
                if (result.more()) {
                    result.next();
                }
            },
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.list',
            [
                'select' => ['id', 'title', 'number', 'entityId', 'createTime'],
                'order' => ['id' => 'desc'],
                'filter' => ['entityTypeId' => 2, 'entityId' => 101],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.documentgenerator.document.list", b24.Params{
        	"select": []string{"id", "title", "number", "entityId", "createTime"},
        	"order": b24.Params{
        		"id": "desc",
        	},
        	"filter": b24.Params{
        		"entityTypeId": 2,
        		"entityId":     101,
        	},
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.documentgenerator.document.list: %w", err)
        }
        
        // The method wraps the response in an object with the "documents" key.
        raw, ok := b24.Unwrap(res.Result, "documents")
        if !ok {
        	return fmt.Errorf("no documents key in the response")
        }
        
        var items []struct {
        	ID         b24.ID `json:"id"`
        	Title      string `json:"title"`
        	Number     string `json:"number"`
        	TemplateID b24.ID `json:"templateId"`
        	FileID     b24.ID `json:"fileId"`
        	ImageID    b24.ID `json:"imageId"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }