For AI agents: markdown of this page — /docs-content-en/applications/connectors.md documentation index — /llms.txt

Application connectors

An application reads data from external services through the company's connectors. A Bitrix24 account administrator approves the application's access to a connector on request.

List application connectors

GET /v1/applications/:id/connectors

Returns the company's published connectors, the application's access state for each of them, and their read tools. Call it before an access request to get the connector code and the current state.

Parameters

Parameter Type Required Description
Parameterid (path) Typestring Requiredyes DescriptionApplication card ID. Get it from: GET /v1/applications

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/applications/APPLICATION_ID/connectors \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/applications/APPLICATION_ID/connectors \
  -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/applications/APPLICATION_ID/connectors', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.map((connector) => `${connector.slug}: ${connector.appState}`))

JavaScript — OAuth application

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

const { success, data } = await res.json()
console.log(data.map((connector) => `${connector.slug}: ${connector.appState}`))

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionCompany connectors
Fielddata[].slug Typestring DescriptionConnector code. Required for an access request
Fielddata[].title Typestring DescriptionConnector title
Fielddata[].iconUrl Typestring / null DescriptionIcon URL; null for a connector from the company catalog
Fielddata[].appState Typestring DescriptionApplication access state: DISABLED_ON_PORTAL, NOT_CONNECTED, CONNECTION_BROKEN, NO_GRANT, GRANT_PENDING, GRANT_DENIED, GRANT_REVOKED, EXPOSURE_WIDENED or AVAILABLE
Fielddata[].readTools Typearray DescriptionConnector read tools
Fielddata[].readTools[].name Typestring DescriptionTool name
Fielddata[].readTools[].title Typestring DescriptionTool title
Fielddata[].readTools[].description Typestring DescriptionTool description
Fielddata[].readTools[].inputSchema Typeobject DescriptionJSON Schema of the tool arguments
Fielddata[].exposure.linkAccess Typestring DescriptionCurrent link access of the application: OFF, VIBECODE_AUTH, PUBLIC
Fielddata[].exposure.externalApiEnabled Typeboolean DescriptionWhether the application's external API is enabled

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "slug": "orders",
      "title": "Orders",
      "iconUrl": "https://vibecode.bitrix24.com/api/connectors/orders/icon",
      "appState": "GRANT_PENDING",
      "readTools": [],
      "exposure": {
        "linkAccess": "OFF",
        "externalApiEnabled": false
      }
    }
  ]
}

Error response example

404 — the application does not exist, the caller has no permission to manage it, or connectors for applications are disabled for the Bitrix24 account:

JSON 
{
  "success": false,
  "error": {
    "code": "APPLICATION_NOT_FOUND",
    "message": "APPLICATION_NOT_FOUND"
  }
}

Errors

HTTP Code Description
HTTP404 CodeAPPLICATION_NOT_FOUND DescriptionThe application does not exist, is unavailable, is on a different server than the key, or connectors for applications are disabled for the portal
HTTP403 CodeEXTERNAL_COLLABORATOR_KEY_SERVER_MISMATCH DescriptionThe external collaborator's key and the application are not bound to the same server
HTTP403 CodeEXTERNAL_COLLABORATOR_NOT_A_MEMBER DescriptionThe external developer's membership was revoked or has expired
HTTP403 CodePORTAL_COLLABORATOR_NOT_A_MEMBER DescriptionThe user is no longer a member of the server's development team
HTTP401 CodeINVALID_API_KEY DescriptionInvalid key
HTTP401 CodeMISSING_API_KEY DescriptionX-Api-Key was not passed

Full list of common API errors — Errors.

See also