Filter Deal Categories crm.dealcategory.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:
crmWho can execute the method: any user
DEPRECATED
The development of this method has been halted. Please use crm.category.list.
This 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
Go
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 datasets (< 1000 items) due to high memory load.
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 chunks using an iterator. Use for large datasets for efficient memory consumption.
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: Manual control of pagination through the start parameter. Use for precise control over request batches. Less efficient for large data 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.dealcategory.list", b24.Params{
"order": b24.Params{
"SORT": "ASC",
},
"filter": b24.Params{
"IS_LOCKED": "N",
},
"select": []string{"ID", "NAME", "SORT"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.dealcategory.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)