Get Task List task.item.list
Scope:
taskWho can execute the method: any user
The method returns an array of tasks, each containing an array of fields (similar to the array returned by task.item.getdata).
Warning
The method is deprecated and not supported. It is recommended to use the methods tasks.task.*.
Method Parameters
|
Name |
Description |
|
ORDER |
An array of the form
The sorting direction can take the following values:
Optional parameter. By default, it is sorted in descending order by task ID |
|
FILTER |
An array of the form
Before the name of the filter field, you can specify the type of filtering:
Filter values can be a single value or an array. Optional parameter. By default, records are not filtered. For the |
|
PARAMS |
An array for call options. An element is an array
|
|
SELECT |
An array of record fields that will be returned by the method. If the array contains the value The default value (empty array |
Maintaining the order of parameters in the request is mandatory. If violated, the request will be executed with errors.
However, if some parameters need to be skipped, they still need to be passed, but as empty arrays: ORDER[]=&FILTER[]=&PARAMS[]=&SELECT[]=.
Code Examples
How to Use Examples in Documentation
Get a list of all tasks (by default, pagination will be applied — 50 items per page).
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/task.item.list?auth=**put_access_token_here**
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'task.item.list',
{},
(progress) => { console.log('Progress:', progress) }
)
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('task.item.list', {}, '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('task.item.list', {}, 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(
'task.item.list',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Data: ' . print_r($result, true);
echo 'Full Result: ' . print_r($response, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching task list: ' . $e->getMessage();
}
BX24.callMethod(
'task.item.list',
[],
function(result)
{
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.list',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Get a list of tasks with IDs 1, 2, 3, 4, 5, 6, selecting only the fields ID and TITLE. Pagination mode — 2 items per page, 2nd page. Sorting by ID — descending.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"desc"},"filter":{"ID":[1,2,3,4,5,6]},"params":{"NAV_PARAMS":{"nPageSize":2,"iNumPage":2}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"desc"},"filter":{"ID":[1,2,3,4,5,6]},"params":{"NAV_PARAMS":{"nPageSize":2,"iNumPage":2}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.item.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(
'task.item.list',
[
{ID: 'desc'}, // Sorting by ID — descending.
{ID: [1, 2, 3, 4, 5, 6]}, // Filter
{
NAV_PARAMS: { // pagination
nPageSize: 2, // 2 items per page.
iNumPage: 2 // page number 2
}
}
],
(progress) => { console.log('Progress:', progress) }
);
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('task.item.list', [
{ID: 'desc'}, // Sorting by ID — descending.
{ID: [1, 2, 3, 4, 5, 6]}, // Filter
{
NAV_PARAMS: { // pagination
nPageSize: 2, // 2 items per page.
iNumPage: 2 // page number 2
}
}
], '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('task.item.list', [
{ID: 'desc'}, // Sorting by ID — descending.
{ID: [1, 2, 3, 4, 5, 6]}, // Filter
{
NAV_PARAMS: { // pagination
nPageSize: 2, // 2 items per page.
iNumPage: 2 // page number 2
}
}
], 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(
'task.item.list',
[
['ID' => 'desc'], // Sorting by ID — descending.
['ID' => [1, 2, 3, 4, 5, 6]], // Filter
[
'NAV_PARAMS' => [ // pagination
'nPageSize' => 2, // 2 items per page.
'iNumPage' => 2 // page number 2
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching task list: ' . $e->getMessage();
}
BX24.callMethod(
'task.item.list',
[
{ID : 'desc'}, // Sorting by ID — descending.
{ID: [1,2,3,4,5,6]}, // Filter
{
NAV_PARAMS: { // pagination
nPageSize : 2, // 2 items per page.
iNumPage : 2 // page number 2
}
}
],
function(result)
{
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.list',
[
'order' => ['ID' => 'desc'],
'filter' => ['ID' => [1, 2, 3, 4, 5, 6]],
'params' => [
'NAV_PARAMS' => [
'nPageSize' => 2,
'iNumPage' => 2
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';