Untuk agen AI: markdown halaman ini — /docs-content-en/entities/pages/resolve.md indeks dokumentasi — /llms.txt

Artikel dokumentasi saat ini tersedia dalam bahasa Inggris.

Resolve a page by URL

GET /v1/pages/resolve

Finds a page by its path within a site. An absent site or a path matching no readable page returns 404. Missing required query parameters return 400. The resolved page is independently checked with the credential owner permissions.

Requires the landing scope. Available to a READONLY key.

Request parameters

Field Type Required Description
scope string no Query: KNOWLEDGE, GROUP or MAINPAGE; omit for an ordinary site.
siteId integer yes Query: site from List sites.
path string yes Query: path within the site, for example /example/.

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/pages/resolve?siteId=10&path=%2Fexample%2F" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/pages/resolve?siteId=10&path=%2Fexample%2F" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/resolve?siteId=10&path=%2Fexample%2F", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/resolve?siteId=10&path=%2Fexample%2F", {
  method: "GET",
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Response fields

Field Type Description
success boolean true
data object Operation result.
data.pageId integer Resolved page ID.
JSON 
{
  "success": true,
  "data": {
    "pageId": 42
  }
}

Errors

HTTP Code Condition
400 MISSING_REQUIRED_FIELDS Required parameters are missing.
400 INVALID_PARAMS Invalid body shape or parameter value.
400 INVALID_SCOPE Invalid scope.
401 TOKEN_MISSING No Bitrix24 credentials.
403 SCOPE_DENIED The key lacks landing.
403 BITRIX_ACCESS_DENIED The Bitrix24 user lacks permission.
404 ENTITY_NOT_FOUND Site or page at the path not found.
422 BITRIX_ERROR Bitrix24 business refusal; its message is preserved.
422 BITRIX_NO_EFFECT Bitrix24 did not confirm the action or return the expected result.

All system errors.

400 — invalid scope:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_SCOPE",
    "message": "scope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted."
  }
}

See also