Get Contact Fields crm.contact.fields

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: any user

DEPRECATED

The development of this method has been halted. Please use crm.item.fields.

This method returns the description of contact fields, including custom fields.

No parameters are required.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.fields
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmContactFields = Record<string, CrmContactFieldDescription>
        
        type CrmContactFieldDescription = {
          type: string
          isRequired: boolean
          isReadOnly: boolean
          isImmutable: boolean
          isMultiple: boolean
          isDynamic: boolean
          title: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmContactFields>({
            method: 'crm.contact.fields',
            params: {},
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Contact fields:', Object.keys(result))
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getContactFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.contact.fields',
                params: {},
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Contact fields:', Object.keys(result))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getContactFields)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Contact Fields: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching contact fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.contact.fields",
            {},
            (result) => {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Contact Fields", result.data());
            }
        );    
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.contact.fields", nil, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.contact.fields: %w", err)
        }
        
        keys, ok := b24.Keys(res.Result)
        if !ok {
        	return fmt.Errorf("expected an object in the response")
        }
        fmt.Println("fields in response:", len(keys))

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "ID"
                },
                "HONORIFIC": {
                    "type": "crm_status",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "statusType": "HONORIFIC",
                    "title": "Salutation"
                },
                "NAME": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "First Name"
                },
                "SECOND_NAME": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Middle Name"
                },
                "LAST_NAME": {
                    "type": "string",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Last Name"
                },
                "PHOTO": {
                    "type": "file",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Photo"
                },
                "BIRTHDATE": {
                    "type": "date",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Birthdate"
                },
                "TYPE_ID": {
                    "type": "crm_status",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "statusType": "CONTACT_TYPE",
                    "title": "Contact Type"
                },
                "SOURCE_ID": {
                    "type": "crm_status",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "statusType": "SOURCE",
                    "title": "Source"
                },
                "SOURCE_DESCRIPTION": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Additional Source Information"
                },
                "POST": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Position"
                },
                "ADDRESS": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Address"
                },
                "ADDRESS_2": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Address (Line 2)"
                },
                "ADDRESS_CITY": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "City"
                },
                "ADDRESS_POSTAL_CODE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Postal Code"
                },
                "ADDRESS_REGION": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Region"
                },
                "ADDRESS_PROVINCE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Province"
                },
                "ADDRESS_COUNTRY": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Country"
                },
                "ADDRESS_COUNTRY_CODE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Country Code"
                },
                "ADDRESS_LOC_ADDR_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Location Address ID"
                },
                "COMMENTS": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Comment"
                },
                "OPENED": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Available to All"
                },
                "EXPORT": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Participates in Contact Export"
                },
                "HAS_PHONE": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Phone Set"
                },
                "HAS_EMAIL": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "E-mail Set"
                },
                "HAS_IMOL": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Open Line Set"
                },
                "ASSIGNED_BY_ID": {
                    "type": "user",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Responsible Person"
                },
                "CREATED_BY_ID": {
                    "type": "user",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Created By"
                },
                "MODIFY_BY_ID": {
                    "type": "user",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Modified By"
                },
                "DATE_CREATE": {
                    "type": "datetime",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Creation Date"
                },
                "DATE_MODIFY": {
                    "type": "datetime",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Modification Date"
                },
                "COMPANY_ID": {
                    "type": "crm_company",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "isDeprecated": true,
                    "title": "Company"
                },
                "COMPANY_IDS": {
                    "type": "crm_company",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "COMPANY_IDS"
                },
                "LEAD_ID": {
                    "type": "crm_lead",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Lead",
                    "settings": {
                        "parentEntityTypeId": 1
                    }
                },
                "ORIGINATOR_ID": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "External Source"
                },
                "ORIGIN_ID": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Identifier in External Source"
                },
                "ORIGIN_VERSION": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Original Version"
                },
                "UTM_SOURCE": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Advertising System"
                },
                "UTM_MEDIUM": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Traffic Type"
                },
                "UTM_CAMPAIGN": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Campaign Identifier"
                },
                "UTM_CONTENT": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Campaign Content"
                },
                "UTM_TERM": {
                    "type": "string",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Campaign Search Condition"
                },
                "LAST_ACTIVITY_TIME": {
                    "type": "datetime",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Last Activity"
                },
                "LAST_ACTIVITY_BY": {
                    "type": "user",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Last Activity By"
                },
                "PHONE": {
                    "type": "crm_multifield",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "Phone"
                },
                "EMAIL": {
                    "type": "crm_multifield",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "E-mail"
                },
                "WEB": {
                    "type": "crm_multifield",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "Website"
                },
                "IM": {
                    "type": "crm_multifield",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "Messenger"
                },
                "LINK": {
                    "type": "crm_multifield",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": true,
                    "isDynamic": false,
                    "title": "LINK"
                }
            },
            "time": {
                "start": 1715004755.782705,
                "finish": 1715004756.118899,
                "duration": 0.3361940383911133,
                "processing": 0.10344505310058594,
                "date_start": "2024-05-06T17:12:35+02:00",
                "date_finish": "2024-05-06T17:12:36+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

ID
integer

Identifier of the contact. Read-only

HONORIFIC
crm_status

Salutation.

You can get the values from the directory using the method crm.status.list with the filter ENTITY_ID=HONORIFIC

NAME
string

First Name

SECOND_NAME
string

Middle Name

LAST_NAME
string

Last Name

PHOTO
file

Photo

BIRTHDATE
date

Birthdate

TYPE_ID
crm_status

Contact Type.

You can get the values from the directory using the method crm.status.list with the filter ENTITY_ID=CONTACT_TYPE

SOURCE_ID
crm_status

Source.

You can get the values from the directory using the method crm.status.list with the filter ENTITY_ID=SOURCE

SOURCE_DESCRIPTION
string

Additional Source Information

POST
string

Position

COMMENTS
string

Comment. Supports BB codes

OPENED
char

Available to all. Possible values:

  • Y — yes
  • N — no

Considered in access permission for roles with "All Open" access level

EXPORT
char

Participates in contact export. Possible values:

  • Y — yes
  • N — no

HAS_PHONE
char

Is phone set. Possible values:

  • Y — yes
  • N — no

Read-only

HAS_EMAIL
char

Is e-mail set. Possible values:

  • Y — yes
  • N — no

Read-only

HAS_IMOL
char

Is open line set. Possible values:

  • Y — yes
  • N — no

Read-only

ASSIGNED_BY_ID
user

Responsible Person

CREATED_BY_ID
user

Created By. Read-only

MODIFY_BY_ID
user

Modified By. Read-only

DATE_CREATE
datetime

Creation Date. Read-only

DATE_MODIFY
datetime

Modification Date. Read-only

COMPANY_ID
crm_company

Main company of the contact

COMPANY_IDS
crm_company

Contact's association with companies. Multiple.

In the methods crm.contact.update and crm.contact.add it is used to submit an array of companies.

In the methods crm.contact.list and crm.contact.get this field is not present and you need to use crm.contact.company.items.get to get the list of companies

LEAD_ID
crm_lead

Identifier of the lead associated with the contact. Read-only

UTM_SOURCE
string

Advertising system (Google Ads, Microsoft Advertising, etc.)

UTM_MEDIUM
string

Traffic type. Possible values:

  • CPC — ads
  • CPM — banners

UTM_CAMPAIGN
string

Campaign identifier

UTM_CONTENT
string

Campaign content. For example, for contextual ads

UTM_TERM
string

Campaign search condition. For example, keywords for contextual advertising

LAST_ACTIVITY_TIME
datetime

Date of last activity in the timeline. Read-only

LAST_ACTIVITY_BY
user

Author of the last activity in the timeline. Read-only

PHONE
crm_multifield

Phones. Multiple

EMAIL
crm_multifield

E-mail. Multiple

WEB
crm_multifield

Websites. Multiple

IM
crm_multifield

Messengers. Multiple

LINK
crm_multifield

Links. Multiple. Service field.

UF_...

Custom fields. For example, UF_CRM_25534736.

Depending on the portal settings, contacts may have a set of custom fields of specific types.

You can add a custom field to a contact using the method crm.contact.userfield.add

PARENT_ID_...

Relationship fields.

If there are smart processes associated with contacts on the portal, there is a field for each such smart process that stores the relationship between that smart process and the contact. The field itself stores the identifier of the element of that smart process.

For example, the field PARENT_ID_153 — relationship with the smart process entityTypeId=153. It stores the identifier of the element of that smart process associated with the current contact

Fields for External Data Sources

If the contact was created by an external system, then:

  • the field ORIGINATOR_ID stores the string identifier of that system
  • the field ORIGIN_ID stores the string identifier of the contact in that external system
  • the field ORIGIN_VERSION stores the version of the contact data in that external system

Name
type

Description

ORIGINATOR_ID
string

Identifier of the external system that is the source of data about this contact

ORIGIN_ID
string

Identifier of the contact in the external system

ORIGIN_VERSION
string

Version of the contact data in the external system.

Used to protect data from accidental overwriting by the external system.

If the data was imported and not changed in the external system, such data can be edited in the CRM without fear that the next export will lead to data overwriting

Deprecated Fields

Address fields in the contact are deprecated and are only used for compatibility mode. For working with addresses, use requisites.

Name
type

Description

ADDRESS
string

Address

ADDRESS_2
string

Second line of the address

ADDRESS_CITY
string

City

ADDRESS_POSTAL_CODE
string

Postal Code

ADDRESS_REGION
string

Region

ADDRESS_PROVINCE
string

Province

ADDRESS_COUNTRY
string

Country

ADDRESS_COUNTRY_CODE
string

Country Code

ADDRESS_LOC_ADDR_ID
location

Location Address ID

Error Handling

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Delete contact
Next
Overview of Methods