For AI agents: markdown of this page — /docs-content-en/entities/automated-solutions/get.md documentation index — /llms.txt

Get a workspace

GET /v1/automated-solutions/:id

Returns one digital workspace by its identifier together with the smart process types bound to it.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionWorkspace identifier. List: GET /v1/automated-solutions
Parameterselect (query) Typestring Requiredno DescriptionComma-separated response fields: id, title, typeIds. Example: ?select=title. The id field is always returned. An unknown field name does not cause an error: the field is missing from the response, and meta.warnings carries an UNKNOWN_SELECT_FIELD warning

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/automated-solutions/9" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/automated-solutions/9" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/automated-solutions/9', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Workspace:', data.title, '— bound types:', data.typeIds)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/automated-solutions/9', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionWorkspace
Fielddata.id Typenumber DescriptionWorkspace identifier
Fielddata.title Typestring DescriptionWorkspace name
Fielddata.typeIds Typearray DescriptionIDs of the bound smart process types — the type id field from GET /v1/smart-processes, not its entityTypeId. An empty array if no types are bound

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 9,
    "title": "HR processes",
    "typeIds": [63]
  }
}

Error response example

404 — workspace not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo workspace with that id exists on the portal
HTTP400 CodeINVALID_PARAMS DescriptionThe id in the path is not a non-negative integer. The request is rejected before reaching the portal
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP429 CodeCALLER_RATE_LIMITED DescriptionThe shared caller limit for this API key or its owner has been reached. The response has Retry-After and X-RateLimit-Scope; it does not expose the effective limit in x-ratelimit-limit
HTTP429 CodeRATE_LIMITED DescriptionBitrix24 refused the request because its own rate limit was reached. Retry after the delay in Retry-After; this response does not report the route limit in x-ratelimit-limit

For the full list of common API errors, see Errors.

See also