Get a List of Leads crm.lead.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["*","UF_*"],"start":50,"filter":{"=OPPORTUNITY":15000},"order":{"STATUS_ID":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.lead.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 each lead object returned in result[]
        type CrmLeadListItem = {
          ID: string
          TITLE: string
          NAME: string | null
          LAST_NAME: string | null
          STATUS_ID: string
          SOURCE_ID: string
          CURRENCY_ID: string
          OPPORTUNITY: string
          ASSIGNED_BY_ID: string
          OPENED: string
          DATE_CREATE: ISODate | null
          DATE_MODIFY: ISODate | null
        }
        
        try {
          // crm.lead.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<CrmLeadListItem[]>({
            method: 'crm.lead.list',
            params: {
              select: ['*', 'UF_*'],
              filter: {
                '=OPPORTUNITY': 15000,
              },
              order: {
                STATUS_ID: 'ASC',
              },
              start: 50,
            },
            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('Leads on this page:', result.length, result)
          }
        } 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 listLeads() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.lead.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.lead.list',
                params: {
                  select: ['*', 'UF_*'],
                  filter: {
                    '=OPPORTUNITY': 15000,
                  },
                  order: {
                    STATUS_ID: 'ASC',
                  },
                  start: 50,
                },
                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('Leads on this page:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listLeads)
        </script>
        

try {
            $order = [];
            $filter = []; // Define your filter criteria here
            $select = [
                'ID', 'TITLE', 'HONORIFIC', 'NAME', 'SECOND_NAME', 'LAST_NAME', 
                'BIRTHDATE', 'COMPANY_TITLE', 'SOURCE_ID', 'SOURCE_DESCRIPTION', 
                'STATUS_ID', 'STATUS_DESCRIPTION', 'STATUS_SEMANTIC_ID', 'POST', 
                'ADDRESS', 'ADDRESS_2', 'ADDRESS_CITY', 'ADDRESS_POSTAL_CODE', 
                'ADDRESS_REGION', 'ADDRESS_PROVINCE', 'ADDRESS_COUNTRY', 
                'ADDRESS_COUNTRY_CODE', 'ADDRESS_LOC_ADDR_ID', 'CURRENCY_ID', 
                'OPPORTUNITY', 'IS_MANUAL_OPPORTUNITY', 'OPENED', 'COMMENTS', 
                'HAS_PHONE', 'HAS_EMAIL', 'HAS_IMOL', 'ASSIGNED_BY_ID', 
                'CREATED_BY_ID', 'MODIFY_BY_ID', 'MOVED_BY_ID', 'DATE_CREATE', 
                'DATE_MODIFY', 'MOVED_TIME', 'COMPANY_ID', 'CONTACT_ID', 
                'CONTACT_IDS', 'IS_RETURN_CUSTOMER', 'DATE_CLOSED', 
                'ORIGINATOR_ID', 'ORIGIN_ID', 'UTM_SOURCE', 'UTM_MEDIUM', 
                'UTM_CAMPAIGN', 'UTM_CONTENT', 'UTM_TERM', 'PHONE', 'EMAIL', 
                'WEB', 'IM', 'LINK'
            ];
            $startItem = 0;
            $leadsResult = $serviceBuilder->getCRMScope()->lead()->list($order, $filter, $select, $startItem);
            
            foreach ($leadsResult->getLeads() as $lead) {
                print("ID: {$lead->ID}, TITLE: {$lead->TITLE}, NAME: {$lead->NAME}, BIRTHDATE: " . 
                      ($lead->BIRTHDATE ? $lead->BIRTHDATE->format(DATE_ATOM) : 'N/A') . "\n");
            }
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage());
        }
        

BX24.callMethod(
          'crm.lead.list',
          {
            select: ['*', 'UF_*'],
            filter: {
                '=OPPORTUNITY': 15000,
            },
            order: {
                STATUS_ID: 'ASC',
            }, 
          },
          (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.lead.list',
            [
                'select' => ['*', 'UF_*'],
                'start' => 50,
                'filter' => [
                    '=OPPORTUNITY' => 15000,
                ],
                'order' => [
                    'STATUS_ID' => 'ASC',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.lead.list(
                select=["ID", "TITLE", "STATUS_ID", "OPPORTUNITY", "CURRENCY_ID", "ASSIGNED_BY_ID", "DATE_CREATE"],
                filter={">OPPORTUNITY": 0, "!STATUS_ID": "CONVERTED", "=OPENED": "Y"},
                order={"DATE_CREATE": "DESC", "ID": "DESC"},
                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.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.lead.list(
                select=["ID", "TITLE", "STATUS_ID"],
                filter={"!STATUS_ID": "JUNK"},
                order={"ID": "ASC"},
            ).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.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.lead.list(
                select=["ID", "TITLE", "STATUS_ID"],
                filter={"!STATUS_ID": "JUNK"},
                order={"ID": "DESC"},
            ).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}")
        

BX24.callMethod(
            "crm.lead.list",
            {
                filter: { "PHONE": "555888" },
                select: [ "ID", "TITLE" ]
            },
            (result) => {
              if(result.error())
              {
                console.error(result.error());
              }
              else
              {
                console.dir(result.data());
                if (result.more())
                {
                  result.next();
                }
              }
            }
        );
        

$result = CRest::call(
            'crm.lead.list',
            [
                'filter' => [
                    '>DATE_CREATE' => '2023-10-01T00:00:00',
                    '<DATE_CREATE' => '2023-10-31T23:59:59',
                ],
                'select' => [
                    'ID',
                    'DATE_CREATE',
                ],
            ]
        );