Filter Deal Categories crm.dealcategory.list
Scope:
crmWho can execute the method: any user
Warning
The method is deprecated. It is recommended to use crm.category.list
The method returns a list of deal categories based on the filter. It is an implementation of list methods for deal categories.
Method Parameters
See the description of list methods
Code Examples
How to Use Examples in Documentation
cURL (Webhook)
cURL (OAuth)
JS
PHP
BX24.js
PHP CRest
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"IS_LOCKED":"N"},"select":["ID","NAME","SORT"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.dealcategory.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"IS_LOCKED":"N"},"select":["ID","NAME","SORT"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.dealcategory.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'crm.dealcategory.list',
{
order: { "SORT": "ASC" },
filter: { "IS_LOCKED": "N" },
select: [ "ID", "NAME", "SORT" ]
}
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('crm.dealcategory.list', {
order: { "SORT": "ASC" },
filter: { "IS_LOCKED": "N" },
select: [ "ID", "NAME", "SORT" ]
}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('crm.dealcategory.list', {
order: { "SORT": "ASC" },
filter: { "IS_LOCKED": "N" },
select: [ "ID", "NAME", "SORT" ]
}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'crm.dealcategory.list',
[
'order' => ['SORT' => 'ASC'],
'filter' => ['IS_LOCKED' => 'N'],
'select' => ['ID', 'NAME', 'SORT'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($result->more()) {
$result->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching deal categories: ' . $e->getMessage();
}
BX24.callMethod(
"crm.dealcategory.list",
{
order: { "SORT": "ASC" },
filter: { "IS_LOCKED": "N" }, //Y - all categories, N - all categories except deleted. Deleted categories are not permanently removed from the database but only blocked.
select: [ "ID", "NAME", "SORT" ]
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.dir(result.data());
if(result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.dealcategory.list',
[
'order' => ['SORT' => 'ASC'],
'filter' => ['IS_LOCKED' => 'N'],
'select' => ['ID', 'NAME', 'SORT']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Copied