Bitrix24 REST API

Table Structure

  • Deals
  • Leads
  • Companies
  • Contacts
  • Deals

    Field Description Read Write
    ID Deal ID. It is created automatically and is unique for the database. Yes No
    TITLE Deal name. A mandatory field. Yes Yes
    TYPE_ID Deal type ID. Yes Yes
    STAGE_ID Deal stage ID Yes Yes
    PROBABILITY Deal conclusion probability (in %) Yes Yes
    CURRENCY_ID Deal currency Yes Yes
    OPPORTUNITY Amount in deal currency Yes Yes
    COMPANY_ID ID of a company that is a counterpart to the deal Yes Yes
    CONTACT_ID Contact person ID Yes Yes
    BEGINDATE Deal opening date Yes Yes
    CLOSEDATE Deal closing date Yes Yes
    OPENED Checkmark "Available to everyone" Yes Yes
    CLOSED Checkmark "The deal is closed" Yes Yes
    COMMENTS Comments Yes Yes
    ASSIGNED_BY_ID Deal responsibleís ID Yes Yes
    CREATED_BY_ID Deal creatorís ID Yes No
    MODIFY_BY_ID ID of a person who modified the deal Yes No
    DATE_CREATE Creation date Yes No
    DATE_MODIFY Modification date Yes No
    LEAD_ID Lead ID Yes No
    ADDITIONAL_INFO Additional information Yes Yes
    ORIGINATOR_ID ID of the external information database. The field assignment can be modified by the end developer. Yes Yes
    ORIGIN_ID External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes

    Leads

    Field Description Read Write
    ID Lead ID Yes No
    TITLE Lead name. A mandatory field. Yes Yes
    NAME Contact personís name Yes Yes
    SECOND_NAME Contact personís patronymic Yes Yes
    LAST_NAME Last name Yes Yes
    COMPANY_TITLE Company name Yes Yes
    SOURCE_ID Source ID Yes Yes
    SOURCE_DESCRIPTION Additional information about the source Yes Yes
    STATUS_ID Lead status ID Yes Yes
    STATUS_DESCRIPTION Additional information about the status Yes Yes
    POST Position Yes Yes
    ADDRESS Address Yes Yes
    CURRENCY_ID Currency ID Yes Yes
    OPPORTUNITY Supposed amount Yes Yes
    OPENED Checkmark "Available for all" Yes Yes
    COMMENTS Comments Yes Yes
    ASSIGNED_BY_ID Responsible person Yes Yes
    CREATED_BY_ID Created by Yes No
    MODIFY_BY_ID Modified by Yes No
    DATE_CREATE Creation date Yes No
    DATE_MODIFY Modification date Yes No
    COMPANY_ID Company ID Yes No
    CONTACT_ID Contact personís ID Yes No
    DATE_CLOSED Closing date Yes No
    PHONE Phone Yes Yes
    EMAIL E-mail Yes Yes
    WEB Website Yes Yes
    IM Contact person in the instant messaging service Yes Yes
    ORIGINATOR_ID External information base ID. Field assignment can be changed by the end developer. Yes Yes
    ORIGIN_ID External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes

    Companies

    Field Description Read Write
    ID Company ID. It is created automatically and is unique for the database. Yes No
    TITLE Company name. A mandatory field. Yes Yes
    COMPANY_TYPE Company type. To be selected from the list. Yes Yes
    LOGO Company logo Yes Yes
    ADDRESS Physical address Yes Yes
    ADDRESS_LEGAL Legal address Yes Yes
    BANKING_DETAILS Bank details Yes Yes
    INDUSTRY Area of activity. To be selected from the list. Yes Yes
    EMPLOYEES Number of employees. To be selected from the list. Yes Yes
    CURRENCY_ID Settlement currency Yes Yes
    REVENUE Annual turnover Yes Yes
    OPENED Check mark "Available for all" Yes Yes
    COMMENTS Comments Yes Yes
    ASSIGNED_BY_ID Responsible personís ID Yes Yes
    CREATED_BY_ID Created by Yes No
    MODIFY_BY_ID Modified by Yes No
    DATE_CREATE Creation date Yes No
    DATE_MODIFY Modification date Yes No
    LEAD_ID Lead ID Yes No
    ORIGINATOR_ID ID of the external information database. The field assignment can be modified by the end developer. Yes Yes
    ORIGIN_ID External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes
    PHONE Phone Yes Yes
    EMAIL E-mail Yes Yes
    WEB Website Yes Yes
    IM Contact person in the instant messaging service. Yes Yes

    Contacts

    Field Description Read Write
    ID Contact ID. It is created automatically and is unique for the database. Yes No
    NAME Contact name. A mandatory field. Yes Yes
    SECOND_NAME Contact personís patronymic. A mandatory field. Yes Yes
    LAST_NAME Contact personís last name. A mandatory field. Yes Yes
    PHOTO Contact personís photo. Yes Yes
    BIRTHDATE Contact personís date of birth Yes Yes
    TYPE_ID Type of contact Yes Yes
    SOURCE_ID Source Yes Yes
    SOURCE_DESCRIPTION Additional information about the source Yes Yes
    POST Position Yes Yes
    ADDRESS Address Yes Yes
    OPENED Check mark "Available for all" Yes Yes
    COMMENTS Comments Yes Yes
    EXPORT Export permission checkmark Yes Yes
    ASSIGNED_BY_ID Responsible personís ID Yes Yes
    CREATED_BY_ID Created by Yes No
    MODIFY_BY_ID Modified by Yes No
    DATE_CREATE Creation date Yes No
    DATE_MODIFY Modification date Yes No
    COMPANY_ID Company ID ńŗ ńŗ
    LEAD_ID Lead ID Yes No
    PHONE Phone Yes Yes
    EMAIL E-mail Yes Yes
    WEB Website Yes Yes
    IM Contact person in the instant messaging service Yes Yes
    ORIGINATOR_ID External information base ID. Field assignment can be changed by the end developer. Yes Yes
    ORIGIN_ID External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes


    User comments

    Comments by users are not official documentation. Responsibility for use of the comments are born by users themselves.

    The user comments section is not intended as a request box or training area, but rather for specific usage examples. For more general inquiries, please refer to link.

    Comments may be added only by registered users and appear after moderation.
    © 2001-2017 Bitrix, Inc. Bitrixģ is a registered trademark of Bitrix, Inc. Powered by Bitrix Site Manager