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
id (path) number yes Workspace identifier. List: GET /v1/automated-solutions

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
success boolean Always true on success
data object Workspace
data.id number Workspace identifier
data.title string Workspace name
data.typeIds array IDs 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
404 ENTITY_NOT_FOUND No workspace with that id exists on the portal
400 INVALID_PARAMS The id in the path is not a non-negative integer. The request is rejected before reaching the portal
401 MISSING_API_KEY The X-Api-Key header was not passed
401 TOKEN_MISSING The API key has no configured tokens
403 SCOPE_DENIED The API key does not have the crm scope
429 RATE_LIMITED Rate limit exceeded: 300 requests per minute per portal, all API keys of the portal share one limit. The exact value arrives in the x-ratelimit-limit header (the cap is divided across replicas). Retry after the delay in the Retry-After header

Full list of common API errors — Errors.

See also