Get a list of registered application robots bizproc.robot.list
Scope:
bizprocWho can execute the method: administrator
The method returns a list of robots registered by the application.
It works only in the context of the application.
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.robot.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(
'bizproc.robot.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('bizproc.robot.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('bizproc.robot.list', {}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$result = $serviceBuilder
->getBizProcScope()
->robot()
->list();
foreach ($result->getRobots() as $robot) {
print($robot->code);
print($robot->name);
print($robot->handlerUrl);
print($robot->authUserId);
print($robot->isUseSubscription ? 'Yes' : 'No');
print($robot->isUsePlacement ? 'Yes' : 'No');
if ($robot->createdDate instanceof DateTime) {
print($robot->createdDate->format(DateTime::ATOM));
}
}
} catch (Throwable $e) {
// Handle the exception
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'bizproc.robot.list',
{},
function(result)
{
if(result.error())
alert("Error: " + result.error());
else
alert("Success: " + result.data().join(', '));
}
);
require_once('crest.php');
$result = CRest::call(
'bizproc.robot.list',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
"test_robot",
"sms_robot"
],
"time": {
"start": 1738151724.710429,
"finish": 1738151724.7319269,
"duration": 0.021497964859008789,
"processing": 0.0011229515075683594,
"date_start": "2025-01-29T14:55:24+01:00",
"date_finish": "2025-01-29T14:55:24+01:00",
"operating_reset_at": 1738152324,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
List of application robot identifiers |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
Error Message |
Description |
|
|
Application context required |
Application context is required |
|
|
Access denied! |
The method was not executed by an administrator |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Application Automation Rules
- Register a New Robot bizproc.robot.add
- Update Robot Fields bizproc.robot.update
- Delete Registered Robot bizproc.robot.delete
- Return parameters to the action or Automation rule bizproc.event.send