Данные приложения

GET /v1/apps/:id

Возвращает одно приложение портала по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) string да Идентификатор приложения. Список: GET /v1/apps

Примеры

curl — личный ключ

Terminal 
curl https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Приложение:', data)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id string Идентификатор приложения
data.title string Название
data.description string | null Описание
data.scopes string[] Скоупы Битрикс24, закреплённые за ключом приложения
data.handlerUrl string Адрес обработчика на стороне платформы. Подробнее — Приложения
data.appUrl string | null Адрес приложения на Black Hole. До публикации — null
data.redirectUris string[] Разрешённые адреса возврата OAuth
data.bitrixClientId string | null Идентификатор OAuth-клиента на портале
data.prefix string Префикс ключа приложения
data.suffix string Последние символы ключа приложения
data.authorId string Идентификатор автора приложения
data.portalId string Идентификатор портала
data.createdAt string Дата создания, ISO 8601
data.updatedAt string Дата изменения, ISO 8601
data.placements string[] Привязанные места встраивания. До публикации — пустой массив

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": "33c4d5e6-f7a8-49b0-1234-5c6d7e8f9012",
    "title": "Дашборд продаж",
    "description": "Аналитика сделок в карточке CRM",
    "scopes": ["crm", "user", "placement"],
    "handlerUrl": "https://vibecode.bitrix24.tech/v1/bitrix-handler",
    "appUrl": "https://app-abc12345.vibecode.bitrix24.tech",
    "redirectUris": [
      "https://vibecode.bitrix24.tech/oauth/complete",
      "http://localhost"
    ],
    "bitrixClientId": "local.7c3d4e5f6a7b80.55556666",
    "prefix": "vibe_app_local_7c3",
    "suffix": "6666",
    "authorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "portalId": "8b1f0e2a-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
    "createdAt": "2026-06-24T09:12:45.781Z",
    "updatedAt": "2026-06-24T09:12:45.781Z",
    "placements": []
  }
}

Пример ответа при ошибке

404 — приложение не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "APP_NOT_FOUND",
    "message": "Application not found"
  }
}

Ошибки

HTTP Код Описание
404 APP_NOT_FOUND Приложение с указанным id не принадлежит порталу ключа или не существует
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Удалённое приложение возвращает 404 APP_NOT_FOUND — тем же кодом, что и никогда не существовавший идентификатор. Отличить «удалено» от «не существовало» по ответу нельзя.

Смотрите также