لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/userfields/types.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Module custom-field types

GET /v1/userfields/types?moduleId=crm

Returns only userTypeId and description. Internal PHP keys are removed. The key must hold the scope named by moduleId. For smart processes use crm. The main module returns No settings for UserFieldAccess. Employee field types are not available here.

Parameters

Parameter Type Required Description
ParametermoduleId (query) Typestring Requiredyes DescriptionModule identifier, e.g. crm. The key must hold that scope.

Examples

curl — personal key

Terminal 

curl "https://vibecode.bitrix24.com/v1/userfields/types?moduleId=crm" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 

curl "https://vibecode.bitrix24.com/v1/userfields/types?moduleId=crm" \
  -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/userfields/types?moduleId=crm', {
  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/userfields/types?moduleId=crm', {
  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
Fieldsuccess Typeboolean Descriptiontrue
Fielddata Typearray DescriptionAvailable field types.
Fielddata[].userTypeId Typestring DescriptionType identifier for field creation.
Fielddata[].description Typestring DescriptionDescription in the Bitrix24 account language.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "userTypeId": "crm",
      "description": "Bind To CRM items"
    },
    {
      "userTypeId": "string",
      "description": "String"
    },
    {
      "userTypeId": "enumeration",
      "description": "List"
    }
  ]
}

Error response example

422 — the main module has no type settings:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "No settings for UserFieldAccess",
    "b24Code": "0"
  }
}

Errors

HTTP Code Condition
HTTP400 CodeINVALID_PARAMS ConditionMissing or malformed moduleId.
HTTP401 CodeMISSING_API_KEY ConditionMissing key.
HTTP403 CodeSCOPE_DENIED ConditionMissing requested module scope.
HTTP403 CodeBITRIX_ACCESS_DENIED ConditionBitrix24 refuses access.
HTTP422 CodeBITRIX_ERROR ConditionNo module type settings or another business refusal.

All errors

See also