Get a List of Estimates by Filter crm.quote.list

Scope: crm

Who can execute the method: a user with "read" access permission for estimates

Method Development Halted

The method crm.quote.list continues to function, but there is a more current equivalent, crm.item.list.

The method crm.quote.list returns a list of estimates based on a filter.

This method implements the list method for estimates.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
string[]

A list of fields to return in the response.

You can use masks for selection:

  • '*' — to select all standard fields (excluding custom and multiple fields),
  • 'UF_*' — to select all custom fields.

You can retrieve the list of available fields for selection using the method crm.quote.fields.

By default, all standard fields and custom fields are returned ('*' + 'UF_*')

filter
object

An object in the format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            "...": "..."
        }
        

where:

  • field_n — the name of the field to filter the selection,
  • value_n — the filter value.

The filter key format: <operator><field>.
Example: >=DATE_CREATE, @ASSIGNED_BY_ID, =%TITLE.

Supported operators:

  • = — equals (exact match, used by default)
  • != — not equal
  • ! — not equal
  • > — greater than
  • >= — greater than or equal to
  • < — less than
  • <= — less than or equal to
  • @ — IN (an array is passed in the value)
  • !@ — NOT IN (an array is passed in the value)
  • % — LIKE, substring search
  • =% — LIKE, pattern search
  • %= — LIKE (similar to =%)

For LIKE:

  • =%TITLE: "%fur" — substring anywhere
  • =%TITLE: "fur%" — starts with fur
  • =%TITLE: "%fur" — ends with fur

You can retrieve the list of available fields for filtering using the method crm.quote.fields

order
object

An object in the format:

{
            "field_1": "ASC",
            "field_2": "DESC"
        }
        

where:

  • field_n — the sorting field,
  • value:
    • ASC — ascending,
    • DESC — descending.

You can retrieve the list of available fields for sorting using the method crm.quote.fields.

When sorting by STATUS_ID, the internal field STATUS_SORT is used

start
integer

Pagination parameter.

Page size — 50 records.

Formula:

start = (N - 1) * 50, where N — page number

Code Examples

How to Use Examples in Documentation

Select estimates:

  • for the company with COMPANY_ID = 1,
  • with the stage SENT,
  • sorted by stage and ID,
  • with selected fields: ID, TITLE, STATUS_ID, OPPORTUNITY, CURRENCY_ID, ASSIGNED_BY_ID.
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"STATUS_ID":"ASC","ID":"ASC"},"filter":{"=COMPANY_ID":1,"=STATUS_ID":"SENT"},"select":["ID","TITLE","STATUS_ID","OPPORTUNITY","CURRENCY_ID","ASSIGNED_BY_ID"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"STATUS_ID":"ASC","ID":"ASC"},"filter":{"=COMPANY_ID":1,"=STATUS_ID":"SENT"},"select":["ID","TITLE","STATUS_ID","OPPORTUNITY","CURRENCY_ID","ASSIGNED_BY_ID"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.quote.list
        
try {
          await $b24.callListMethod(
            'crm.quote.list',
            {
              order: { STATUS_ID: 'ASC', ID: 'ASC' },
              filter: { '=COMPANY_ID': 1, '=STATUS_ID': 'SENT' },
              select: ['ID', 'TITLE', 'STATUS_ID', 'OPPORTUNITY', 'CURRENCY_ID', 'ASSIGNED_BY_ID'],
            },
            (progress) => {
              progress.error()
                ? console.error(progress.error())
                : console.info(progress.data())
              ;
            },
          );
        } catch (error) {
          console.error('Request failed', error);
        }
        
        try {
          const generator = $b24.fetchListMethod(
            'crm.quote.list',
            {
              order: { STATUS_ID: 'ASC', ID: 'ASC' },
              filter: { '=COMPANY_ID': 1, '=STATUS_ID': 'SENT' },
              select: ['ID', 'TITLE', 'STATUS_ID', 'OPPORTUNITY', 'CURRENCY_ID', 'ASSIGNED_BY_ID'],
            },
            'ID',
          );
        
          for await (const page of generator) {
            for (const entity of page) {
              console.info(entity);
            }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        try {
          const response = await $b24.callMethod(
            'crm.quote.list',
            {
              order: { STATUS_ID: 'ASC', ID: 'ASC' },
              filter: { '=COMPANY_ID': 1, '=STATUS_ID': 'SENT' },
              select: ['ID', 'TITLE', 'STATUS_ID', 'OPPORTUNITY', 'CURRENCY_ID', 'ASSIGNED_BY_ID'],
              start: 0,
            },
          );
        
          const result = response.getData().result || [];
          console.info(result);
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.quote.list',
                    [
                        'order' => [
                            'STATUS_ID' => 'ASC',
                            'ID' => 'ASC',
                        ],
                        'filter' => [
                            '=COMPANY_ID' => 1,
                            '=STATUS_ID' => 'SENT',
                        ],
                        'select' => [
                            'ID',
                            'TITLE',
                            'STATUS_ID',
                            'OPPORTUNITY',
                            'CURRENCY_ID',
                            'ASSIGNED_BY_ID',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching quote list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.quote.list',
            {
                order: { STATUS_ID: 'ASC', ID: 'ASC' },
                filter: { '=COMPANY_ID': 1, '=STATUS_ID': 'SENT' },
                select: ['ID', 'TITLE', 'STATUS_ID', 'OPPORTUNITY', 'CURRENCY_ID', 'ASSIGNED_BY_ID'],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.quote.list',
            [
                'order' => [
                    'STATUS_ID' => 'ASC',
                    'ID' => 'ASC',
                ],
                'filter' => [
                    '=COMPANY_ID' => 1,
                    '=STATUS_ID' => 'SENT',
                ],
                'select' => [
                    'ID',
                    'TITLE',
                    'STATUS_ID',
                    'OPPORTUNITY',
                    'CURRENCY_ID',
                    'ASSIGNED_BY_ID',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ID": "9",
                    "TITLE": "The latest version of our product",
                    "STATUS_ID": "SENT",
                    "OPPORTUNITY": "45000.00",
                    "CURRENCY_ID": "EUR",
                    "ASSIGNED_BY_ID": "7"
                },
                {
                    "ID": "43",
                    "TITLE": "Estimate for furniture supply",
                    "STATUS_ID": "SENT",
                    "OPPORTUNITY": "150000.00",
                    "CURRENCY_ID": "EUR",
                    "ASSIGNED_BY_ID": "1"
                }
            ],
            "total": 2,
            "time": {
                "start": 1773413037,
                "finish": 1773413037.105712,
                "duration": 0.1057119369506836,
                "processing": 0,
                "date_start": "2026-03-13T17:43:57+01:00",
                "date_finish": "2026-03-13T17:43:57+01:00",
                "operating_reset_at": 1773413637,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object[]

An array of estimates. The composition of fields depends on the select parameter

total
integer

The total number of records found

next
integer

The value for the start parameter in the next request.

The next parameter is returned if the number of items in the selection exceeds 50

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

-

Parameter 'order' must be array.

The order parameter is not an object

-

Parameter 'filter' must be array.

The filter parameter is not an object

-

Access denied.

The user does not have permission to read estimates

-

Failed to get list. General error.

General error executing the request

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning