Activity fields

curl "https://vibecode.bitrix24.com/v1/activities/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl "https://vibecode.bitrix24.com/v1/activities/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

const res = await fetch('https://vibecode.bitrix24.com/v1/activities/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields).length)

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

const { success, data } = await res.json()

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Unique numeric identifier of the activity." },
      "typeId": { "type": "number", "readonly": false, "createOnly": true, "required": true, "label": "Type", "description": "Activity type — codes are decoded in enum (B24 crm.enum.activitytype). Required on create; set only on create and cannot be changed afterward." },
      "subject": { "type": "string", "readonly": false, "required": true, "label": "Subject", "description": "Activity subject. Required on create." },
      "communications": {"type": "array", "readonly": false, "required": true, "label": "Communications", "description": "Activity communications. Required on create. An item may contain type, value, entityTypeId, entityId, id and activityId. Write accepts camelCase or Bitrix24 UPPER keys; read preserves the keys returned by Bitrix24.", "itemSchema": {"type": "object"}},
      "files": {"type": "array", "readonly": false, "label": "Files", "description": "Activity attachments. An item can be a numeric file ID or an object with id and url, depending on the Bitrix24 method. A file name is not guaranteed. On list and search, returned only when files is requested in select; a single activity read may include it without select. The field may be absent.", "itemSchema": {}},
      "responsibleId": { "type": "number", "readonly": false, "label": "Responsible", "description": "ID of the user responsible for the activity." }
    },
    "relations": {
      "responsible": { "type": "one", "entity": "users", "includable": true },
      "author": { "type": "one", "entity": "users", "includable": true },
      "editor": { "type": "one", "entity": "users", "includable": true }
    },
    "aggregatable": ["typeId", "ownerTypeId", "responsibleId", "authorId", "editorId", "completed", "status", "direction", "providerId", "providerTypeId"],
    "aggregateFilterRequirement": {
      "mode": "anyOfAnchors",
      "anchors": [
        { "type": "allOf", "fields": ["ownerTypeId", "ownerId"] },
        { "type": "field", "field": "responsibleId" },
        { "type": "dateBound", "fields": ["createdAt", "updatedAt", "deadline"] }
      ],
      "surfaces": ["aggregate"],
      "enforcement": "advisory"
    },
    "batch": ["create", "update", "delete"],
    "include": ["responsible", "author", "editor"]
  }
}

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope",
    "hint": "This request needs the 'crm' scope, which the calling key does not carry. Add 'crm' to this key in the developer cabinet (or through the management API), then repeat the call.",
    "cause": "key_scope_missing",
    "requiredScope": "crm",
    "keyScopes": ["task"],
    "fix": { "action": "edit_key_scopes", "via": "cabinet" },
    "userMessage": "The app's API key lacks the “CRM” permission. You can add it in the key settings in the developer cabinet."
  }
}