Get a list of digital workspaces crm.automatedsolution.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: 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 |
Description |
|
order |
List for sorting in the format
|
|
filter |
Object for filtering selected digital workspaces in the format
The filter can have unlimited nesting and number of conditions. By default, all conditions are combined using An additional prefix can be assigned to the key to specify the filter's behavior. Possible prefix values:
|
|
start |
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 The formula for calculating the
|
Code Examples
-
Get all digital workspaces sorted by descending
idcURL (Webhook)cURL (OAuth)JS (TS)JS (UMD)PythonPHPGocurl -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.listcurl -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// This snippet is an ES module: top-level await requires type="module" or a bundler. // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide). import { Text } from '@bitrix24/b24jssdk' import type { B24Frame } from '@bitrix24/b24jssdk' declare const $b24: B24Frame type AutomatedSolutionItem = { id: number title: string typeIds: number[] } // Shape of the payload returned in result (match the "response handling" section of the page) type AutomatedSolutionListResult = { automatedSolutions: AutomatedSolutionItem[] } // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. try { const response = await $b24.actions.v2.call.make<AutomatedSolutionListResult>({ method: 'crm.automatedsolution.list', params: { order: { id: 'DESC' }, start: 0, }, requestId: Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) } else { const result = response.getData()!.result console.info(result.automatedSolutions.length, result.automatedSolutions) } } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) }<!-- Load the SDK (UMD build); it is exposed as the global B24Js --> <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script> <script> async function listAutomatedSolutions() { try { // Initialize the SDK inside a Bitrix24 frame const $b24 = await B24Js.initializeB24Frame() // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. const response = await $b24.actions.v2.call.make({ method: 'crm.automatedsolution.list', params: { order: { id: 'DESC' }, start: 0, }, requestId: B24Js.Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) return } const result = response.getData().result console.info(result.automatedSolutions.length, result.automatedSolutions) } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } } document.addEventListener('DOMContentLoaded', listAutomatedSolutions) </script>Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={"id": "DESC"}, start=0, ).response result = bitrix_response.result print(result) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_listfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={"id": "ASC"}, ).as_list().response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_list_fastfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={"id": "DESC"}, ).as_list_fast(descending=True).response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.list', [ 'order' => [ 'id' => 'DESC' ] ] ); 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.automatedsolution.list", b24.Params{ "order": b24.Params{ "id": "DESC", }, }, b24.WithIdempotent()) if err != nil { return fmt.Errorf("crm.automatedsolution.list: %w", err) } // The method wraps the response in an object with the "automatedSolutions" key. raw, ok := b24.Unwrap(res.Result, "automatedSolutions") if !ok { return fmt.Errorf("no automatedSolutions key in the response") } var items []struct { ID b24.ID `json:"id"` Title string `json:"title"` } if err := json.Unmarshal(raw, &items); err != nil { return fmt.Errorf("parse response: %w", err) } for _, it := range items { fmt.Println(it.ID) } -
Get all digital workspaces whose titles start with "HR"
cURL (Webhook)cURL (OAuth)JS (TS)JS (UMD)PythonPHPGocurl -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.listcurl -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// This snippet is an ES module: top-level await requires type="module" or a bundler. // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide). import { Text } from '@bitrix24/b24jssdk' import type { B24Frame } from '@bitrix24/b24jssdk' declare const $b24: B24Frame type AutomatedSolutionItem = { id: number title: string typeIds: number[] } // Shape of the payload returned in result (match the "response handling" section of the page) type AutomatedSolutionListResult = { automatedSolutions: AutomatedSolutionItem[] } // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. try { const response = await $b24.actions.v2.call.make<AutomatedSolutionListResult>({ method: 'crm.automatedsolution.list', params: { filter: { '%=title': 'HR%' }, start: 0, }, requestId: Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) } else { const result = response.getData()!.result console.info(result.automatedSolutions.length, result.automatedSolutions) } } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) }<!-- Load the SDK (UMD build); it is exposed as the global B24Js --> <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script> <script> async function listAutomatedSolutionsByTitle() { try { // Initialize the SDK inside a Bitrix24 frame const $b24 = await B24Js.initializeB24Frame() // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. const response = await $b24.actions.v2.call.make({ method: 'crm.automatedsolution.list', params: { filter: { '%=title': 'HR%' }, start: 0, }, requestId: B24Js.Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) return } const result = response.getData().result console.info(result.automatedSolutions.length, result.automatedSolutions) } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } } document.addEventListener('DOMContentLoaded', listAutomatedSolutionsByTitle) </script>Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( filter={ "%=title": "HR%", }, order={ "title": "ASC", }, start=0, ).response result = bitrix_response.result print(result) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_listfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( filter={ "%=title": "HR%", }, order={ "title": "ASC", }, ).as_list().response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_list_fastfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( filter={ "%=title": "HR%", }, order={ "title": "ASC", }, ).as_list_fast(descending=True).response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.list', [ 'filter' => [ '%=title' => 'HR%' ] ] ); 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.automatedsolution.list", b24.Params{ "filter": b24.Params{ "%=title": "HR%", }, }, b24.WithIdempotent()) if err != nil { return fmt.Errorf("crm.automatedsolution.list: %w", err) } // The method wraps the response in an object with the "automatedSolutions" key. raw, ok := b24.Unwrap(res.Result, "automatedSolutions") if !ok { return fmt.Errorf("no automatedSolutions key in the response") } var items []struct { ID b24.ID `json:"id"` Title string `json:"title"` } if err := json.Unmarshal(raw, &items); err != nil { return fmt.Errorf("parse response: %w", err) } for _, it := range items { fmt.Println(it.ID) } -
Get all digital workspaces whose titles start with "HR" or "Customer" and
idgreater than100, sorted by titlecURL (Webhook)cURL (OAuth)JS (TS)JS (UMD)PythonPHPGocurl -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.listcurl -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// This snippet is an ES module: top-level await requires type="module" or a bundler. // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide). import { Text } from '@bitrix24/b24jssdk' import type { B24Frame } from '@bitrix24/b24jssdk' declare const $b24: B24Frame type AutomatedSolutionItem = { id: number title: string typeIds: number[] } // Shape of the payload returned in result (match the "response handling" section of the page) type AutomatedSolutionListResult = { automatedSolutions: AutomatedSolutionItem[] } // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. try { const response = await $b24.actions.v2.call.make<AutomatedSolutionListResult>({ method: 'crm.automatedsolution.list', params: { order: { title: 'ASC' }, filter: { '>id': 100, '0': { logic: 'OR', '0': { '%=title': 'HR%' }, '1': { '%=title': 'Customer%' }, }, }, start: 0, }, requestId: Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) } else { const result = response.getData()!.result console.info(result.automatedSolutions.length, result.automatedSolutions) } } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) }<!-- Load the SDK (UMD build); it is exposed as the global B24Js --> <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script> <script> async function listFilteredAutomatedSolutions() { try { // Initialize the SDK inside a Bitrix24 frame const $b24 = await B24Js.initializeB24Frame() // crm.automatedsolution.list returns a single page (max 50 records). For the whole result set // use a list helper: $b24.actions.v2.callList.make() returns every record as one // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator). // NOTE: the list helpers do not accept `order` (it is excluded from their params, so // passing it is a TS error) — keep this call.make + `start` variant when sort matters. const response = await $b24.actions.v2.call.make({ method: 'crm.automatedsolution.list', params: { order: { title: 'ASC' }, filter: { '>id': 100, '0': { logic: 'OR', '0': { '%=title': 'HR%' }, '1': { '%=title': 'Customer%' }, }, }, start: 0, }, requestId: B24Js.Text.getUuidRfc4122() }) // The payload is available only on a successful response if (!response.isSuccess) { console.error(response.getErrorMessages().join('; ')) return } const result = response.getData().result console.info(result.automatedSolutions.length, result.automatedSolutions) } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } } document.addEventListener('DOMContentLoaded', listFilteredAutomatedSolutions) </script>Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={ "title": "ASC", }, filter={ ">id": 100, "0": { "logic": "OR", "0": { "%=title": "HR%", }, "1": { "%=title": "Customer%", }, }, }, start=0, ).response result = bitrix_response.result print(result) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_listfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={ "title": "ASC", }, filter={ ">id": 100, "0": { "logic": "OR", "0": { "%=title": "HR%", }, "1": { "%=title": "Customer%", }, }, }, ).as_list().response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")Example
as_list_fastfrom b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.automatedsolution.list( order={ "title": "ASC", }, filter={ ">id": 100, "0": { "logic": "OR", "0": { "%=title": "HR%", }, "1": { "%=title": "Customer%", }, }, }, ).as_list_fast(descending=True).response result = bitrix_response.result for item in result: print(item) except BitrixAPIError as error: print( "Bitrix API error", f"error: {error.error}", f"error_description: {error.error_description}", sep="\n", ) except BitrixSDKException as error: print(f"Bitrix SDK error: {error.message}") except Exception as error: print(f"Unexpected error: {error}")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>';// client and ctx are already created — see the Go SDK section res, err := client.Core().Call(ctx, "crm.automatedsolution.list", b24.Params{ "order": b24.Params{ "title": "ASC", }, "filter": b24.Params{ ">id": 100, "0": b24.Params{ "logic": "OR", "0": b24.Params{ "%=title": "HR%", }, "1": b24.Params{ "%=title": "Customer%", }, }, }, }, b24.WithIdempotent()) if err != nil { return fmt.Errorf("crm.automatedsolution.list: %w", err) } // The method wraps the response in an object with the "automatedSolutions" key. raw, ok := b24.Unwrap(res.Result, "automatedSolutions") if !ok { return fmt.Errorf("no automatedSolutions key in the response") } var items []struct { ID b24.ID `json:"id"` Title string `json:"title"` } if err := json.Unmarshal(raw, &items); err != nil { return fmt.Errorf("parse response: %w", err) } for _, it := range items { fmt.Println(it.ID) }
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 |
Description |
|
result |
Root element of the response |
|
automatedSolutions |
Array of objects with information about selected payments |
|
total |
Total number of records found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":"ACCESS_DENIED",
"error_description":"Insufficient permissions"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions |
|
|
Invalid input argument value. Details can be found in the error message |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Automated Solutions: Methods Overview
- Create Digital Workspace crm.automatedsolution.add
- Update Digital Workplace crm.automatedsolution.update
- Get data about the digital workplace by id crm.automatedsolution.get
- Delete Digital Workplace crm.automatedsolution.delete
- Get fields of the digital workplace crm.automatedsolution.fields