For AI agents: markdown of this page — /docs-content-en/entities/calendar-resources/fields.md documentation index — /llms.txt

Calendar resource fields

GET /v1/calendar-resources/fields · Bitrix24 API: local entity schema · Scope: calendar

Parameters

Parameter	Type	Required	Description

Examples

Terminal

curl -X GET "https://vibecode.bitrix24.com/v1/calendar-resources/fields" -H "X-Api-Key: $VIBE_API_KEY"

Terminal

curl -X GET "https://vibecode.bitrix24.com/v1/calendar-resources/fields" -H "X-Api-Key: $VIBE_API_KEY" -H "Authorization: Bearer $VIBE_USER_TOKEN"

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/calendar-resources/fields', {
  method: 'GET',
  headers: { 'X-Api-Key': apiKey }
});
console.log(await response.json());

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/calendar-resources/fields', {
  method: 'GET',
  headers: { 'X-Api-Key': apiKey , 'Authorization': `Bearer ${userToken}` }
});
console.log(await response.json());

Response

JSON

{"success":true,"data":{"id":{"type":"number","readonly":true},"name":{"type":"string","required":true},"createdBy":{"type":"number","readonly":true}}}

Response fields

Field	Type	Description
success	boolean	True on success.
data	object	Static field metadata for id, name and createdBy.

Errors

HTTP	Code	Condition
400	INVALID_PARAMS	Invalid IDs, dates or status.
400	MISSING_REQUIRED_FIELDS	Required values are absent.
401	TOKEN_MISSING	The key has no usable B24 credentials.
403	SCOPE_DENIED	calendar scope is missing.
403	WRITE_BLOCKED_READONLY_KEY	The key forbids a write.
403	BITRIX_ACCESS_DENIED	Bitrix24 denied access.
422	BITRIX_ERROR	B24 refused the operation or did not persist the write.
429	RATE_LIMITED	Request limit exceeded.
502	BITRIX_UNAVAILABLE	Invalid or unavailable B24 response.
503	BITRIX_TIMEOUT	B24 timed out.

Invalid input returns an error instead of an empty result: