Get a list of digital workspaces crm.automatedsolution.list

Scope: crm

Who can execute the method: users with administrative access to the CRM section

The method will return an array of digital workspace settings. Each element of the array is a structure similar to the response from the request crm.automatedsolution.get.

Method Parameters

Name `type`	Description
order `object`	List for sorting in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where the key is the field and the value is `ASC` or `DESC`. Available fields for sorting: `id` `title`
filter `object`	Object for filtering selected digital workspaces in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Available fields for filtering: `id` `title` The filter can have unlimited nesting and number of conditions. By default, all conditions are combined using `AND`. If you need to use `OR`, you can pass a special key `logic` with the value `OR`. An additional prefix can be assigned to the key to specify the filter's behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `%` — LIKE, substring search. The `%` symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string. `=%` — LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searching for values starting with "mol" `"%mol"` — searching for values ending with "mol" `"%mol%"` — searching for values where "mol" can be in any position. `%=` — LIKE (see description above) `!%` — NOT LIKE, substring search. The `%` symbol in the filter value does not need to be passed. The search goes from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searching for values not starting with "mol" `"%mol"` — searching for values not ending with "mol" `"%mol%"` — searching for values where the substring "mol" is not present in any position. `!%=` — NOT LIKE (see description above) `=` — equals, exact match (used by default) `!=` - not equal
start `integer`	This parameter is used for pagination control. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number

Code Examples

Get all digital workspaces sorted by descending id

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"id":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"id":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.list

BX24.callMethod(
            "crm.automatedsolution.list",
            {
                "order": {
                    "id": "DESC",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.list',
            [
                'order' => [
                    'id' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Get all digital workspaces whose titles start with "HR"

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"%=title":"HR%"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"%=title":"HR%"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.list

BX24.callMethod(
            "crm.automatedsolution.list",
            {
                "filter": {
                    "%=title": "HR%"
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.list',
            [
                'filter' => [
                    '%=title' => 'HR%'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Get all digital workspaces whose titles start with "HR" or "Customer" and id greater than 100, sorted by title

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"title":"ASC"},"filter":{">id":100,"0":{"logic":"OR","0":{"%=title":"HR%"},"1":{"%=title":"Customer%"}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"title":"ASC"},"filter":{">id":100,"0":{"logic":"OR","0":{"%=title":"HR%"},"1":{"%=title":"Customer%"}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automatedsolution.list

BX24.callMethod(
            "crm.automatedsolution.list",
            {
                "order": {
                    "title": "ASC"
                },
                "filter": {
                    ">id": 100,
                    "0": {
                        "logic": "OR",
                        "0": {
                            "%=title": "HR%"
                        },
                        "1": {
                            "%=title": "Customer%"
                        }
                    }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.list',
            [
                'order' => [
                    'title' => 'ASC'
                ],
                'filter' => [
                    '>id' => 100,
                    '0' => [
                        'logic' => 'OR',
                        '0' => [
                            '%=title' => 'HR%'
                        ],
                        '1' => [
                            '%=title' => 'Customer%'
                        ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
        	"result": {
        		"automatedSolutions": [
        			{
        				"id": 238,
        				"title": "HR",
        				"typeIds": [
        					129
        				]
        			},
        			{
        				"id": 240,
        				"title": "Customer Success",
        				"typeIds": []
        			},
        			{
        				"id": 267,
        				"title": "R&D",
        				"typeIds": [
        					14,
        					158
        				]
        			}
        		]
        	},
        	"total": 3,
        	"time": {
        		"start": 1715849396.642359,
        		"finish": 1715849396.954623,
        		"duration": 0.31226396560668945,
        		"processing": 0.0068209171295166016,
        		"date_start": "2024-05-16T11:49:56+03:00",
        		"date_finish": "2024-05-16T11:49:56+03:00",
        		"operating_reset_at": 1715849996,
        		"operating": 0
        	}
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
automatedSolutions `object`	Array of objects with information about selected payments
total `integer`	Total number of records found
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error":"ACCESS_DENIED",
            "error_description":"Insufficient permissions"
        }

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
`ACCESS_DENIED`	Insufficient permissions
`INVALID_ARG_VALUE`	Invalid input argument value. Details can be found in the error message

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

Retrieve Digital Workspace Data by ID

Delete a Digital Workspace

Get a list of digital workspaces crm.automatedsolution.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning