How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bitrix24

Bitrix24 CRM API

The CRM API from Bitrix24 — 421 operation(s) for crm.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bitrix24 CRM API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 421 operations across 421 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

421 operations 421 paths 3 schemas 421 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
Contact
Bitrix24 Developer Support
License
MIT
Resource Areas
1

Authentication & Security 2

Bitrix24 CRM API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 421

Across 421 paths, the API surfaces 421 operations — 421 POST. Each is listed below with its method, path, parameters, and response codes.

CRM 421
POST
/crm.activity.add
Add System Activity crm.activity.add
crm_activity_add body → 2004XX
POST
/crm.activity.badge.add
Add Badge crm.activity.badge.add
crm_activity_badge_add body → 2004XX
POST
/crm.activity.badge.delete
Delete Badge by Code crm.activity.badge.delete
crm_activity_badge_delete body → 2004XX
POST
/crm.activity.badge.get
Get Badge Information by Code crm.activity.badge.get
crm_activity_badge_get body → 2004XX
POST
/crm.activity.badge.list
Get the list of badges crm.activity.badge.list
crm_activity_badge_list body → 2004XX
POST
/crm.activity.binding.add
Add a deal binding to a CRM entity crm.activity.binding.add
crm_activity_binding_add body → 2004XX
POST
/crm.activity.binding.delete
Delete the deal's connection with the CRM entity crm.activity.binding.delete
crm_activity_binding_delete body → 2004XX
POST
/crm.activity.binding.list
Get a list of all bindings for the deal crm.activity.binding.list
crm_activity_binding_list body → 2004XX
POST
/crm.activity.binding.move
Update the Deal's Connection with the CRM Entity crm.activity.binding.move
crm_activity_binding_move body → 2004XX
POST
/crm.activity.communication.fields
Get Description of Communication crm.activity.communication.fields
crm_activity_communication_fields body → 2004XX
POST
/crm.activity.configurable.add
Add Configurable CRM Activity crm.activity.configurable.add
crm_activity_configurable_add body → 2004XX
POST
/crm.activity.configurable.get
Get Configurable Activity by ID crm.activity.configurable.get
crm_activity_configurable_get body → 2004XX
POST
/crm.activity.configurable.update
Update Configurable Activity crm.activity.configurable.update
crm_activity_configurable_update body → 2004XX
POST
/crm.activity.delete
Delete activity crm.activity.delete
crm_activity_delete body → 2004XX
POST
/crm.activity.fields
Get a list of fields for crm.activity.fields
crm_activity_fields body → 2004XX
POST
/crm.activity.get
Get information about the activity by ID crm.activity.get
crm_activity_get body → 2004XX
POST
/crm.activity.layout.blocks.delete
Delete a set of additional content blocks in the CRM activity crm.activity.layout.blocks.delete
crm_activity_layout_blocks_delete body → 2004XX
POST
/crm.activity.layout.blocks.get
Get a Set of Additional Content Blocks in the activity crm.activity.layout.blocks.get
crm_activity_layout_blocks_get body → 2004XX
POST
/crm.activity.layout.blocks.set
Set a set of additional content blocks in the activity crm.activity.layout.blocks.set
crm_activity_layout_blocks_set body → 2004XX
POST
/crm.activity.list
Get the list of activities crm.activity.list
crm_activity_list body → 2004XX
POST
/crm.activity.todo.add
Add Universal Activity crm.activity.todo.add
crm_activity_todo_add body → 2004XX
POST
/crm.activity.todo.update
Update universal deal crm.activity.todo.update
crm_activity_todo_update body → 2004XX
POST
/crm.activity.todo.updateColor
Update the color of the universal deal crm.activity.todo.updateColor
crm_activity_todo_updateColor body → 2004XX
POST
/crm.activity.todo.updateDeadline
Update Deadline for Universal Activity crm.activity.todo.updateDeadline
crm_activity_todo_updateDeadline body → 2004XX
POST
/crm.activity.todo.updateDescription
Update the description of the universal activity crm.activity.todo.updateDescription
crm_activity_todo_updateDescription body → 2004XX
POST
/crm.activity.todo.updateResponsibleUser
Update the responsible user for the universal activity crm.activity.todo.updateResponsibleUser
crm_activity_todo_updateResponsibleUser body → 2004XX
POST
/crm.activity.type.add
Add Custom Activity Type crm.activity.type.add
crm_activity_type_add body → 2004XX
POST
/crm.activity.type.delete
Delete Custom Activity Type crm.activity.type.delete
crm_activity_type_delete body → 2004XX
POST
/crm.activity.type.list
Get a list of custom activity types crm.activity.type.list
crm_activity_type_list body → 2004XX
POST
/crm.activity.update
Update System CRM Activity crm.activity.update
crm_activity_update body → 2004XX
POST
/crm.address.add
Add Address crm.address.add
crm_address_add body → 2004XX
POST
/crm.address.delete
Delete address crm.address.delete
crm_address_delete body → 2004XX
POST
/crm.address.fields
Get Description of Address Fields crm.address.fields
crm_address_fields body → 2004XX
POST
/crm.address.list
Get a List of Addresses by Filter crm.address.list
crm_address_list body → 2004XX
POST
/crm.address.update
Update Address for crm.address.update
crm_address_update body → 2004XX
POST
/crm.automatedsolution.add
Create Digital Workspace crm.automatedsolution.add
crm_automatedsolution_add body → 2004XX
POST
/crm.automatedsolution.delete
Delete Digital Workplace crm.automatedsolution.delete
crm_automatedsolution_delete body → 2004XX
POST
/crm.automatedsolution.fields
Get fields of the digital workplace crm.automatedsolution.fields
crm_automatedsolution_fields body → 2004XX
POST
/crm.automatedsolution.get
Get data about the digital workplace by id crm.automatedsolution.get
crm_automatedsolution_get body → 2004XX
POST
/crm.automatedsolution.list
Get a list of digital workspaces crm.automatedsolution.list
crm_automatedsolution_list body → 2004XX
POST
/crm.automatedsolution.update
Update Digital Workplace crm.automatedsolution.update
crm_automatedsolution_update body → 2004XX
POST
/crm.automation.trigger
Activate the crm.automation.trigger
crm_automation_trigger body → 2004XX
POST
/crm.automation.trigger.add
Add Trigger crm.automation.trigger.add
crm_automation_trigger_add body → 2004XX
POST
/crm.automation.trigger.execute
Execute the Trigger crm.automation.trigger.execute
crm_automation_trigger_execute body → 2004XX
POST
/crm.automation.trigger.list
Get the list of triggers crm.automation.trigger.list
crm_automation_trigger_list body → 2004XX
POST
/crm.calllist.add
Create a New Call List crm.calllist.add
crm_calllist_add body → 2004XX
POST
/crm.calllist.get
Get Information About the Call List crm.calllist.get
crm_calllist_get body → 2004XX
POST
/crm.calllist.items.get
Get the list of call participants crm.calllist.items.get
crm_calllist_items_get body → 2004XX
POST
/crm.calllist.list
Get the list of call lists crm.calllist.list
crm_calllist_list body → 2004XX
POST
/crm.calllist.statuslist
Get the list of call statuses crm.calllist.statuslist
crm_calllist_statuslist body → 2004XX
POST
/crm.calllist.update
Update Call List Composition crm.calllist.update
crm_calllist_update body → 2004XX
POST
/crm.catalog.fields
Get Product Catalog Fields crm.catalog.fields
crm_catalog_fields body → 2004XX
POST
/crm.catalog.get
Get Product Catalog by ID crm.catalog.get
crm_catalog_get body → 2004XX
POST
/crm.catalog.list
Get a List of Product Catalogs crm.catalog.list
crm_catalog_list body → 2004XX
POST
/crm.category.add
Add a New Sales Funnel crm.category.add
crm_category_add body → 2004XX
POST
/crm.category.delete
Delete Sales Funnel crm.category.delete
crm_category_delete body → 2004XX
POST
/crm.category.fields
Get Fields of the Sales Funnel crm.category.fields
crm_category_fields body → 2004XX
POST
/crm.category.get
Get the funnel by Id crm.category.get
crm_category_get body → 2004XX
POST
/crm.category.list
Get the list of Sales Funnels crm.category.list
crm_category_list body → 2004XX
POST
/crm.category.update
Update Sales Funnel crm.category.update
crm_category_update body → 2004XX
POST
/crm.company.add
Create a New Company crm.company.add
crm_company_add body → 2004XX
POST
/crm.company.contact.add
Add Contact to the Specified Company crm.company.contact.add
crm_company_contact_add body → 2004XX
POST
/crm.company.contact.delete
Delete Contact from Specified Company crm.company.contact.delete
crm_company_contact_delete body → 2004XX
POST
/crm.company.contact.fields
Get Fields for Company-Contact Connection crm.company.contact.fields
crm_company_contact_fields body → 2004XX
POST
/crm.company.contact.items.delete
Clear the set of contacts associated with the specified company crm.company.contact.items.delete
crm_company_contact_items_delete body → 2004XX
POST
/crm.company.contact.items.get
Retrieve a Set of Contacts Associated with a Specified Company crm.company.contact.items.get
crm_company_contact_items_get body → 2004XX
POST
/crm.company.contact.items.set
Set a Set of Contacts Associated with the Specified Company crm.company.contact.items.set
crm_company_contact_items_set body → 2004XX
POST
/crm.company.delete
Delete Company crm.company.delete
crm_company_delete body → 2004XX
POST
/crm.company.details.configuration.forceCommonScopeForAll
Set Common Company Card for All Users crm.company.details.configuration.forceCommonScopeForAll
crm_company_details_configuration_forceCommonScopeForAll body → 2004XX
POST
/crm.company.details.configuration.get
Get Parameters for crm.company.details.configuration.get
crm_company_details_configuration_get body → 2004XX
POST
/crm.company.details.configuration.reset
Reset Company Card Settings: crm.company.details.configuration.reset
crm_company_details_configuration_reset body → 2004XX
POST
/crm.company.details.configuration.set
Set Parameters for crm.company.details.configuration.set
crm_company_details_configuration_set body → 2004XX
POST
/crm.company.fields
Get Company Fields Description crm.company.fields
crm_company_fields body → 2004XX
POST
/crm.company.get
Get Company Information crm.company.get
crm_company_get body → 2004XX
POST
/crm.company.list
Get a List of Companies by Filter crm.company.list
crm_company_list body → 2004XX
POST
/crm.company.update
Update Existing Company crm.company.update
crm_company_update body → 2004XX
POST
/crm.company.userfield.add
Create a Custom Field for Companies crm.company.userfield.add
crm_company_userfield_add body → 2004XX
POST
/crm.company.userfield.delete
Delete Custom Field for Companies crm.company.userfield.delete
crm_company_userfield_delete body → 2004XX
POST
/crm.company.userfield.get
Get Company Custom Field by ID crm.company.userfield.get
crm_company_userfield_get body → 2004XX
POST
/crm.company.userfield.list
Get a list of custom fields for companies crm.company.userfield.list
crm_company_userfield_list body → 2004XX
POST
/crm.company.userfield.update
Update Company User Field crm.company.userfield.update
crm_company_userfield_update body → 2004XX
POST
/crm.contact.add
Create a New Contact crm.contact.add
crm_contact_add body → 2004XX
POST
/crm.contact.company.add
Add a Company to the Specified Contact crm.contact.company.add
crm_contact_company_add body → 2004XX
POST
/crm.contact.company.delete
Remove a company from the specified contact crm.contact.company.delete
crm_contact_company_delete body → 2004XX
POST
/crm.contact.company.fields
Get Fields for Contact-Company crm.contact.company.fields
crm_contact_company_fields body → 2004XX
POST
/crm.contact.company.items.delete
Clear the set of companies associated with the specified contact crm.contact.company.items.delete
crm_contact_company_items_delete body → 2004XX
POST
/crm.contact.company.items.get
Get a set of companies associated with the specified contact crm.contact.company.items.get
crm_contact_company_items_get body → 2004XX
POST
/crm.contact.company.items.set
Set the set of companies associated with the specified contact crm.contact.company.items.set
crm_contact_company_items_set body → 2004XX
POST
/crm.contact.delete
Delete Contact crm.contact.delete
crm_contact_delete body → 2004XX
POST
/crm.contact.details.configuration.forceCommonScopeForAll
Set a Common Contact Card for All Users crm.contact.details.configuration.forceCommonScopeForAll
crm_contact_details_configuration_forceCommonScopeForAll body → 2004XX
POST
/crm.contact.details.configuration.get
Get Parameters of crm.contact.details.configuration.get
crm_contact_details_configuration_get body → 2004XX
POST
/crm.contact.details.configuration.reset
Resetting the Parameters of crm.contact.details.configuration.reset
crm_contact_details_configuration_reset body → 2004XX
POST
/crm.contact.details.configuration.set
Set Parameters for the Individual Card crm.contact.details.configuration.set
crm_contact_details_configuration_set body → 2004XX
POST
/crm.contact.fields
Get Contact Fields crm.contact.fields
crm_contact_fields body → 2004XX
POST
/crm.contact.get
Get Contact by Id crm.contact.get
crm_contact_get body → 2004XX
POST
/crm.contact.list
Get a List of Contacts crm.contact.list
crm_contact_list body → 2004XX
POST
/crm.contact.update
Update Contact crm.contact.update
crm_contact_update body → 2004XX
POST
/crm.contact.userfield.add
Create a Custom Field for Contacts crm.contact.userfield.add
crm_contact_userfield_add body → 2004XX
POST
/crm.contact.userfield.delete
Delete Custom Contact Field crm.contact.userfield.delete
crm_contact_userfield_delete body → 2004XX
POST
/crm.contact.userfield.get
Get Custom Contact Field by Id crm.contact.userfield.get
crm_contact_userfield_get body → 2004XX
POST
/crm.contact.userfield.list
Get a list of custom fields for contacts crm.contact.userfield.list
crm_contact_userfield_list body → 2004XX
POST
/crm.contact.userfield.update
Update Existing Custom Contact Field crm.contact.userfield.update
crm_contact_userfield_update body → 2004XX
POST
/crm.currency.add
Add Currency crm.currency.add
crm_currency_add body → 2004XX
POST
/crm.currency.base.get
Get the Symbolic Identifier of the Base Currency crm.currency.base.get
crm_currency_base_get body → 2004XX
POST
/crm.currency.base.set
Set Currency as Base crm.currency.base.set
crm_currency_base_set body → 2004XX
POST
/crm.currency.delete
Delete Currency crm.currency.delete
crm_currency_delete body → 2004XX
POST
/crm.currency.fields
Get Currency Fields crm.currency.fields
crm_currency_fields body → 2004XX
POST
/crm.currency.get
Get Currency by ID crm.currency.get
crm_currency_get body → 2004XX
POST
/crm.currency.list
Get the list of currencies crm.currency.list
crm_currency_list body → 2004XX
POST
/crm.currency.localizations.delete
Delete currency localizations crm.currency.localizations.delete
crm_currency_localizations_delete body → 2004XX
POST
/crm.currency.localizations.fields
Get Currency Localization Fields crm.currency.localizations.fields
crm_currency_localizations_fields body → 2004XX
POST
/crm.currency.localizations.get
Get Currency Localizations crm.currency.localizations.get
crm_currency_localizations_get body → 2004XX
POST
/crm.currency.localizations.set
Set Localizations for Currency crm.currency.localizations.set
crm_currency_localizations_set body → 2004XX
POST
/crm.currency.update
Update Currency crm.currency.update
crm_currency_update body → 2004XX
POST
/crm.deal.add
Create a New Deal crm.deal.add
crm_deal_add body → 2004XX
POST
/crm.deal.contact.add
Add Contact to Deal crm.deal.contact.add
crm_deal_contact_add body → 2004XX
POST
/crm.deal.contact.delete
Remove Contact from Specified Deal crm.deal.contact.delete
crm_deal_contact_delete body → 2004XX
POST
/crm.deal.contact.fields
Get Fields for Deal-Contact Connection crm.deal.contact.fields
crm_deal_contact_fields body → 2004XX
POST
/crm.deal.contact.items.delete
Delete the set of contacts associated with the specified deal crm.deal.contact.items.delete
crm_deal_contact_items_delete body → 2004XX
POST
/crm.deal.contact.items.get
Get a set of contacts associated with a deal crm.deal.contact.items.get
crm_deal_contact_items_get body → 2004XX
POST
/crm.deal.contact.items.set
Add Multiple Contacts to a Deal crm.deal.contact.items.set
crm_deal_contact_items_set body → 2004XX
POST
/crm.deal.delete
Delete Deal crm.deal.delete
crm_deal_delete body → 2004XX
POST
/crm.deal.details.configuration.forceCommonScopeForAll
Set a Common Detail Form for All Users crm.deal.details.configuration.forceCommonScopeForAll
crm_deal_details_configuration_forceCommonScopeForAll body → 2004XX
POST
/crm.deal.details.configuration.get
Get Parameters of the Deal Card crm.deal.details.configuration.get
crm_deal_details_configuration_get body → 2004XX
POST
/crm.deal.details.configuration.reset
Reset Deal Card Settings crm.deal.details.configuration.reset
crm_deal_details_configuration_reset body → 2004XX
POST
/crm.deal.details.configuration.set
Set Parameters for the Deal Card crm.deal.details.configuration.set
crm_deal_details_configuration_set body → 2004XX
POST
/crm.deal.fields
Get Fields of the Deal crm.deal.fields
crm_deal_fields body → 2004XX
POST
/crm.deal.get
Get Deal by Id crm.deal.get
crm_deal_get body → 2004XX
POST
/crm.deal.list
Get a List of Deals crm.deal.list
crm_deal_list body → 2004XX
POST
/crm.deal.productrows.get
Get Deal Products crm.deal.productrows.get
crm_deal_productrows_get body → 2004XX
POST
/crm.deal.productrows.set
Set Products in Deal crm.deal.productrows.set
crm_deal_productrows_set body → 2004XX
POST
/crm.deal.recurring.add
Create a Template for Recurring Deal crm.deal.recurring.add
crm_deal_recurring_add body → 2004XX
POST
/crm.deal.recurring.delete
Delete the Recurring Deal Template Setting crm.deal.recurring.delete
crm_deal_recurring_delete body → 2004XX
POST
/crm.deal.recurring.expose
Create a New Deal from the Template crm.deal.recurring.expose
crm_deal_recurring_expose body → 2004XX
POST
/crm.deal.recurring.fields
Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields
crm_deal_recurring_fields body → 2004XX
POST
/crm.deal.recurring.get
Get Recurring Deal Template Settings by ID crm.deal.recurring.get
crm_deal_recurring_get body → 2004XX
POST
/crm.deal.recurring.list
Get a List of Recurring Deal Template Settings crm.deal.recurring.list
crm_deal_recurring_list body → 2004XX
POST
/crm.deal.recurring.update
Update the Recurring Deal Template Settings crm.deal.recurring.update
crm_deal_recurring_update body → 2004XX
POST
/crm.deal.update
Update Deal crm.deal.update
crm_deal_update body → 2004XX
POST
/crm.deal.userfield.add
Create a Custom Field for Deals crm.deal.userfield.add
crm_deal_userfield_add body → 2004XX
POST
/crm.deal.userfield.delete
Delete Custom Field crm.deal.userfield.delete
crm_deal_userfield_delete body → 2004XX
POST
/crm.deal.userfield.get
Get Custom Deal Field by ID crm.deal.userfield.get
crm_deal_userfield_get body → 2004XX
POST
/crm.deal.userfield.list
Get a list of custom fields for deals crm.deal.userfield.list
crm_deal_userfield_list body → 2004XX
POST
/crm.deal.userfield.update
Update Existing Custom Field for Deals crm.deal.userfield.update
crm_deal_userfield_update body → 2004XX
POST
/crm.dealcategory.add
Create a New Deal Direction crm.dealcategory.add
crm_dealcategory_add body → 2004XX
POST
/crm.dealcategory.default.get
Get Default Deal Category Settings crm.dealcategory.default.get
crm_dealcategory_default_get body → 2004XX
POST
/crm.dealcategory.default.set
Set Default Deal Category Settings crm.dealcategory.default.set
crm_dealcategory_default_set body → 2004XX
POST
/crm.dealcategory.delete
Delete Deal Direction crm.dealcategory.delete
crm_dealcategory_delete body → 2004XX
POST
/crm.dealcategory.fields
Get Descriptions of Fields for Deal Categories crm.dealcategory.fields
crm_dealcategory_fields body → 2004XX
POST
/crm.dealcategory.get
Get Deal Direction crm.dealcategory.get
crm_dealcategory_get body → 2004XX
POST
/crm.dealcategory.list
Filter Deal Categories crm.dealcategory.list
crm_dealcategory_list body → 2004XX
POST
/crm.dealcategory.stage.list
Get a List of Deal Stages for the crm.dealcategory.stage.list Endpoint
crm_dealcategory_stage_list body → 2004XX
POST
/crm.dealcategory.status
Get the Identifier of the Directory Where Deal Stages are Stored: crm.dealcategory.status
crm_dealcategory_status body → 2004XX
POST
/crm.dealcategory.update
Update Deal Direction crm.dealcategory.update
crm_dealcategory_update body → 2004XX
POST
/crm.documentgenerator.document.add
Create a New Document crm.documentgenerator.document.add
crm_documentgenerator_document_add body → 2004XX
POST
/crm.documentgenerator.document.delete
Delete Document crm.documentgenerator.document.delete
crm_documentgenerator_document_delete body → 2004XX
POST
/crm.documentgenerator.document.enablepublicurl
Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl
crm_documentgenerator_document_enablepublicurl body → 2004XX
POST
/crm.documentgenerator.document.get
Get Document crm.documentgenerator.document.get
crm_documentgenerator_document_get body → 2004XX
POST
/crm.documentgenerator.document.getfields
Get Document Fields crm.documentgenerator.document.getfields
crm_documentgenerator_document_getfields body → 2004XX
POST
/crm.documentgenerator.document.list
Get a List of Documents crm.documentgenerator.document.list
crm_documentgenerator_document_list body → 2004XX
POST
/crm.documentgenerator.document.update
Update Document crm.documentgenerator.document.update
crm_documentgenerator_document_update body → 2004XX
POST
/crm.documentgenerator.document.upload
Upload Document crm.documentgenerator.document.upload
crm_documentgenerator_document_upload body → 2004XX
POST
/crm.documentgenerator.numerator.add
Add a New Numerator crm.documentgenerator.numerator.add
crm_documentgenerator_numerator_add body → 2004XX
POST
/crm.documentgenerator.numerator.delete
Delete crm.documentgenerator.numerator.delete
crm_documentgenerator_numerator_delete body → 2004XX
POST
/crm.documentgenerator.numerator.get
Get Information About the Numerator crm.documentgenerator.numerator.get
crm_documentgenerator_numerator_get body → 2004XX
POST
/crm.documentgenerator.numerator.list
Get the List of Numerators crm.documentgenerator.numerator.list
crm_documentgenerator_numerator_list body → 2004XX
POST
/crm.documentgenerator.numerator.update
Update the crm.documentgenerator.numerator.update
crm_documentgenerator_numerator_update body → 2004XX
POST
/crm.documentgenerator.template.add
Add a New Template crm.documentgenerator.template.add
crm_documentgenerator_template_add body → 2004XX
POST
/crm.documentgenerator.template.delete
Delete Document Template crm.documentgenerator.template.delete
crm_documentgenerator_template_delete body → 2004XX
POST
/crm.documentgenerator.template.get
Get Information About Document Template by Id crm.documentgenerator.template.get
crm_documentgenerator_template_get body → 2004XX
POST
/crm.documentgenerator.template.getfields
Get Document Template Fields crm.documentgenerator.template.getfields
crm_documentgenerator_template_getfields body → 2004XX
POST
/crm.documentgenerator.template.list
Get a List of Document Templates crm.documentgenerator.template.list
crm_documentgenerator_template_list body → 2004XX
POST
/crm.documentgenerator.template.update
Update Existing Document Template crm.documentgenerator.template.update
crm_documentgenerator_template_update body → 2004XX
POST
/crm.duplicate.findbycomm
Get leads, contacts, and companies with matching data crm.duplicate.findbycomm
crm_duplicate_findbycomm body → 2004XX
POST
/crm.duplicate.volatileType.fields
Get a List of Fields for Duplicate Search crm.duplicate.volatileType.fields
crm_duplicate_volatileType_fields body → 2004XX
POST
/crm.duplicate.volatileType.list
Get a List of Custom Fields Used in Duplicate Search crm.duplicate.volatileType.list
crm_duplicate_volatileType_list body → 2004XX
POST
/crm.duplicate.volatileType.register
Add Field to Duplicate Search crm.duplicate.volatileType.register
crm_duplicate_volatileType_register body → 2004XX
POST
/crm.duplicate.volatileType.unregister
Remove Field from Duplicate Search crm.duplicate.volatileType.unregister
crm_duplicate_volatileType_unregister body → 2004XX
POST
/crm.entity.mergeBatch
Merge Duplicates crm.entity.mergeBatch
crm_entity_mergeBatch body → 2004XX
POST
/crm.enum.activitydirection
Get Activity Direction Enumeration Elements crm.enum.activitydirection
crm_enum_activitydirection body → 2004XX
POST
/crm.enum.activitynotifytype
Get Enumeration Items for "Activity Notification Type" crm.enum.activitynotifytype
crm_enum_activitynotifytype body → 2004XX
POST
/crm.enum.activitypriority
Get Enumeration Items for "Activity Priorities" crm.enum.activitypriority
crm_enum_activitypriority body → 2004XX
POST
/crm.enum.activitystatus
Get Enumeration Elements "Status" crm.enum.activitystatus
crm_enum_activitystatus body → 2004XX
POST
/crm.enum.activitytype
Get Enumeration Elements "Activity Types" crm.enum.activitytype
crm_enum_activitytype body → 2004XX
POST
/crm.enum.addresstype
Get Address Types crm.enum.addresstype
crm_enum_addresstype body → 2004XX
POST
/crm.enum.contenttype
Get Enumeration Elements of "Description Type" crm.enum.contenttype
crm_enum_contenttype body → 2004XX
POST
/crm.enum.fields
Get Fields of CRM Enumeration Elements crm.enum.fields
crm_enum_fields body → 2004XX
POST
/crm.enum.getorderownertypes
Get Object Types for Order Binding crm.enum.getorderownertypes
crm_enum_getorderownertypes body → 2004XX
POST
/crm.enum.ownertype
Get CRM Object Types crm.enum.ownertype
crm_enum_ownertype body → 2004XX
POST
/crm.enum.settings.mode
Get Description of CRM Operation Modes crm.enum.settings.mode
crm_enum_settings_mode body → 2004XX
POST
/crm.invoice.add
Add Invoice crm.invoice.add
crm_invoice_add body → 2004XX
POST
/crm.invoice.delete
Delete invoice crm.invoice.delete
crm_invoice_delete body → 2004XX
POST
/crm.invoice.fields
Get Invoice Fields and Associated Products crm.invoice.fields
crm_invoice_fields body → 2004XX
POST
/crm.invoice.get
Get Invoice by ID crm.invoice.get
crm_invoice_get body → 2004XX
POST
/crm.invoice.getexternallink
Get Link to Invoice crm.invoice.getexternallink
crm_invoice_getexternallink body → 2004XX
POST
/crm.invoice.list
Get a List of Invoices crm.invoice.list
crm_invoice_list body → 2004XX
POST
/crm.invoice.recurring.add
Add Configuration for Recurring Invoice crm.invoice.recurring.add
crm_invoice_recurring_add body → 2004XX
POST
/crm.invoice.recurring.delete
Delete the Recurring Invoice Setting crm.invoice.recurring.delete
crm_invoice_recurring_delete body → 2004XX
POST
/crm.invoice.recurring.expose
Create a New Invoice from the Template crm.invoice.recurring.expose
crm_invoice_recurring_expose body → 2004XX
POST
/crm.invoice.recurring.fields
Get Full Template of Recurring Invoice Fields crm.invoice.recurring.fields
crm_invoice_recurring_fields body → 2004XX
POST
/crm.invoice.recurring.get
Get Recurring Invoice Settings by ID crm.invoice.recurring.get
crm_invoice_recurring_get body → 2004XX
POST
/crm.invoice.recurring.list
Get a List of Recurring Invoice Settings by Filter crm.invoice.recurring.list
crm_invoice_recurring_list body → 2004XX
POST
/crm.invoice.recurring.update
Change Settings for Recurring Invoice crm.invoice.recurring.update
crm_invoice_recurring_update body → 2004XX
POST
/crm.invoice.status.add
Create a New Invoice Status crm.invoice.status.add
crm_invoice_status_add body → 2004XX
POST
/crm.invoice.status.delete
Delete Invoice Status crm.invoice.status.delete
crm_invoice_status_delete body → 2004XX
POST
/crm.invoice.status.fields
Get Invoice Status Fields crm.invoice.status.fields
crm_invoice_status_fields body → 2004XX
POST
/crm.invoice.status.get
Get Invoice Status by ID crm.invoice.status.get
crm_invoice_status_get body → 2004XX
POST
/crm.invoice.status.list
Get a List of Invoice Statuses crm.invoice.status.list
crm_invoice_status_list body → 2004XX
POST
/crm.invoice.status.update
Update Invoice Status crm.invoice.status.update
crm_invoice_status_update body → 2004XX
POST
/crm.invoice.update
Update Invoice crm.invoice.update
crm_invoice_update body → 2004XX
POST
/crm.invoice.userfield.add
Create a Custom Field for Invoices crm.invoice.userfield.add
crm_invoice_userfield_add body → 2004XX
POST
/crm.invoice.userfield.delete
Delete Custom Field of Invoices crm.invoice.userfield.delete
crm_invoice_userfield_delete body → 2004XX
POST
/crm.invoice.userfield.get
Get User Field by ID crm.invoice.userfield.get
crm_invoice_userfield_get body → 2004XX
POST
/crm.invoice.userfield.list
Get a List of Custom Fields by Filter crm.invoice.userfield.list
crm_invoice_userfield_list body → 2004XX
POST
/crm.invoice.userfield.update
Update Custom Field crm.invoice.userfield.update
crm_invoice_userfield_update body → 2004XX
POST
/crm.item.add
Create a New CRM Entity crm.item.add
crm_item_add body → 2004XX
POST
/crm.item.batchImport
Importing a Batch of CRM Records: crm.item.batchImport
crm_item_batchImport body → 2004XX
POST
/crm.item.delete
Delete CRM Item: crm.item.delete
crm_item_delete body → 2004XX
POST
/crm.item.delivery.get
Get Delivery Information by ID crm.item.delivery.get
crm_item_delivery_get body → 2004XX
POST
/crm.item.delivery.list
Get the list of deliveries for a CRM entity crm.item.delivery.list
crm_item_delivery_list body → 2004XX
POST
/crm.item.details.configuration.forceCommonScopeForAll
Set a Common Detail Form for All Users crm.item.details.configuration.forceCommonScopeForAll
crm_item_details_configuration_forceCommonScopeForAll body → 2004XX
POST
/crm.item.details.configuration.reset
Reset Item Card Parameters crm.item.details.configuration.reset
crm_item_details_configuration_reset body → 2004XX
POST
/crm.item.details.configuration.set
Set Parameters for crm.item.details.configuration.set
crm_item_details_configuration_set body → 2004XX
POST
/crm.item.get
Get Element by Id crm.item.get
crm_item_get body → 2004XX
POST
/crm.item.import
Import One Record crm.item.import
crm_item_import body → 2004XX
POST
/crm.item.list
Get a List of CRM Items: crm.item.list
crm_item_list body → 2004XX
POST
/crm.item.payment.add
Add Payment crm.item.payment.add
crm_item_payment_add body → 2004XX
POST
/crm.item.payment.delete
Delete Payment crm.item.payment.delete
crm_item_payment_delete body → 2004XX
POST
/crm.item.payment.delivery.add
Add Delivery Item to Payment crm.item.payment.delivery.add
crm_item_payment_delivery_add body → 2004XX
POST
/crm.item.payment.delivery.delete
Remove Delivery Item from Payment crm.item.payment.delivery.delete
crm_item_payment_delivery_delete body → 2004XX
POST
/crm.item.payment.delivery.list
Get Delivery Item List by Specific Payment crm.item.payment.delivery.list
crm_item_payment_delivery_list body → 2004XX
POST
/crm.item.payment.delivery.setDelivery
Reassign Delivery Position to Another Document crm.item.payment.delivery.setDelivery
crm_item_payment_delivery_setDelivery body → 2004XX
POST
/crm.item.payment.get
Get Payment Information crm.item.payment.get
crm_item_payment_get body → 2004XX
POST
/crm.item.payment.list
Get the list of payments crm.item.payment.list
crm_item_payment_list body → 2004XX
POST
/crm.item.payment.pay
Change Payment Status to "Paid" crm.item.payment.pay
crm_item_payment_pay body → 2004XX
POST
/crm.item.payment.product.add
Adding a Product Item to Payment crm.item.payment.product.add
crm_item_payment_product_add body → 2004XX
POST
/crm.item.payment.product.delete
Remove Product Item from Payment crm.item.payment.product.delete
crm_item_payment_product_delete body → 2004XX
POST
/crm.item.payment.product.list
Get a List of Payment Product Items crm.item.payment.product.list
crm_item_payment_product_list body → 2004XX
POST
/crm.item.payment.product.setQuantity
Change Product Quantity crm.item.payment.product.setQuantity
crm_item_payment_product_setQuantity body → 2004XX
POST
/crm.item.payment.unpay
Change Payment Status to "Unpaid" crm.item.payment.unpay
crm_item_payment_unpay body → 2004XX
POST
/crm.item.payment.update
Update Payment Fields crm.item.payment.update
crm_item_payment_update body → 2004XX
POST
/crm.item.productrow.add
Add Product Row to CRM Object crm.item.productrow.add
crm_item_productrow_add body → 2004XX
POST
/crm.item.productrow.delete
Delete product row from CRM object crm.item.productrow.delete
crm_item_productrow_delete body → 2004XX
POST
/crm.item.productrow.fields
Get the list of fields for product rows crm.item.productrow.fields
crm_item_productrow_fields body → 2004XX
POST
/crm.item.productrow.get
Get information about a product item by id crm.item.productrow.get
crm_item_productrow_get body → 2004XX
POST
/crm.item.productrow.getAvailableForPayment
Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment
crm_item_productrow_getAvailableForPayment body → 2004XX
POST
/crm.item.productrow.list
Get product rows of the CRM object crm.item.productrow.list
crm_item_productrow_list body → 2004XX
POST
/crm.item.productrow.set
Save Product Row of CRM Object crm.item.productrow.set
crm_item_productrow_set body → 2004XX
POST
/crm.item.productrow.update
Update the product row of a CRM object crm.item.productrow.update
crm_item_productrow_update body → 2004XX
POST
/crm.lead.add
Create a New Lead crm.lead.add
crm_lead_add body → 2004XX
POST
/crm.lead.contact.add
Add Contact Binding to Lead crm.lead.contact.add
crm_lead_contact_add body → 2004XX
POST
/crm.lead.contact.delete
Remove contact binding from lead crm.lead.contact.delete
crm_lead_contact_delete body → 2004XX
POST
/crm.lead.contact.fields
Get Lead-Contact Fields crm.lead.contact.fields
crm_lead_contact_fields body → 2004XX
POST
/crm.lead.contact.items.delete
Delete Contact List from Lead crm.lead.contact.items.delete
crm_lead_contact_items_delete body → 2004XX
POST
/crm.lead.contact.items.get
Get a List of Related Contacts crm.lead.contact.items.get
crm_lead_contact_items_get body → 2004XX
POST
/crm.lead.contact.items.set
Attach a list of contacts to a lead crm.lead.contact.items.set
crm_lead_contact_items_set body → 2004XX
POST
/crm.lead.delete
Delete Lead crm.lead.delete
crm_lead_delete body → 2004XX
POST
/crm.lead.details.configuration.forceCommonScopeForAll
Set Common Lead Card for All Users crm.lead.details.configuration.forceCommonScopeForAll
crm_lead_details_configuration_forceCommonScopeForAll body → 2004XX
POST
/crm.lead.details.configuration.get
Get Parameters of crm.lead.details.configuration.get
crm_lead_details_configuration_get body → 2004XX
POST
/crm.lead.details.configuration.reset
Resetting the Parameters of crm.lead.details.configuration.reset
crm_lead_details_configuration_reset body → 2004XX
POST
/crm.lead.details.configuration.set
Set Parameters for crm.lead.details.configuration.set
crm_lead_details_configuration_set body → 2004XX
POST
/crm.lead.fields
Get CRM Lead Fields crm.lead.fields
crm_lead_fields body → 2004XX
POST
/crm.lead.get
Get Lead by Id crm.lead.get
crm_lead_get body → 2004XX
POST
/crm.lead.list
Get a List of Leads crm.lead.list
crm_lead_list body → 2004XX
POST
/crm.lead.productrows.get
Get Lead Product Rows crm.lead.productrows.get
crm_lead_productrows_get body → 2004XX
POST
/crm.lead.productrows.set
Set Products in Lead crm.lead.productrows.set
crm_lead_productrows_set body → 2004XX
POST
/crm.lead.update
Update Lead crm.lead.update
crm_lead_update body → 2004XX
POST
/crm.lead.userfield.add
Create a Custom Field for Leads crm.lead.userfield.add
crm_lead_userfield_add body → 2004XX
POST
/crm.lead.userfield.delete
Delete Custom Field for Leads crm.lead.userfield.delete
crm_lead_userfield_delete body → 2004XX
POST
/crm.lead.userfield.get
Get Custom Lead Field by ID crm.lead.userfield.get
crm_lead_userfield_get body → 2004XX
POST
/crm.lead.userfield.list
Get a List of Custom Fields for Leads crm.lead.userfield.list
crm_lead_userfield_list body → 2004XX
POST
/crm.lead.userfield.update
Update Existing Custom Field for Leads crm.lead.userfield.update
crm_lead_userfield_update body → 2004XX
POST
/crm.measure.add
Add Measurement Unit crm.measure.add
crm_measure_add body → 2004XX
POST
/crm.measure.delete
Delete Measurement Unit crm.measure.delete
crm_measure_delete body → 2004XX
POST
/crm.measure.fields
Get Available Fields of crm.measure.fields
crm_measure_fields body → 2004XX
POST
/crm.measure.get
Get Field Values of Measurement Unit crm.measure.get
crm_measure_get body → 2004XX
POST
/crm.measure.list
Get the List of Measurement Units crm.measure.list
crm_measure_list body → 2004XX
POST
/crm.measure.update
Update Measurement Unit crm.measure.update
crm_measure_update body → 2004XX
POST
/crm.multifield.fields
Get Description of Multiple Fields crm.multifield.fields
crm_multifield_fields body → 2004XX
POST
/crm.orderentity.add
Add Order Binding to CRM Object crm.orderentity.add
crm_orderentity_add body → 2004XX
POST
/crm.orderentity.deleteByFilter
Remove Order Binding to CRM Object crm.orderentity.deleteByFilter
crm_orderentity_deleteByFilter body → 2004XX
POST
/crm.orderentity.getFields
Get Order Binding Fields crm.orderentity.getFields
crm_orderentity_getFields body → 2004XX
POST
/crm.orderentity.list
Get a list of order bindings to CRM entities crm.orderentity.list
crm_orderentity_list body → 2004XX
POST
/crm.paysystem.fields
Get Fields for Payment Methods crm.paysystem.fields
crm_paysystem_fields body → 2004XX
POST
/crm.paysystem.list
Get a List of Payment Methods crm.paysystem.list
crm_paysystem_list body → 2004XX
POST
/crm.persontype.fields
Get Fields for CRM Payer Types crm.persontype.fields
crm_persontype_fields body → 2004XX
POST
/crm.persontype.list
Get a List of CRM Payer Types crm.persontype.list
crm_persontype_list body → 2004XX
POST
/crm.product.add
Add Product crm.product.add
crm_product_add body → 2004XX
POST
/crm.product.delete
Delete Product crm.product.delete
crm_product_delete body → 2004XX
POST
/crm.product.fields
Get Product Fields crm.product.fields
crm_product_fields body → 2004XX
POST
/crm.product.get
Get Product by ID crm.product.get
crm_product_get body → 2004XX
POST
/crm.product.list
Get Product List by Filter crm.product.list
crm_product_list body → 2004XX
POST
/crm.product.property.add
Add Product Property crm.product.property.add
crm_product_property_add body → 2004XX
POST
/crm.product.property.delete
Delete Product Property crm.product.property.delete
crm_product_property_delete body → 2004XX
POST
/crm.product.property.enumeration.fields
Get Fields of List-Type Property crm.product.property.enumeration.fields
crm_product_property_enumeration_fields body → 2004XX
POST
/crm.product.property.fields
Retrieve Product Property Fields crm.product.property.fields
crm_product_property_fields body → 2004XX
POST
/crm.product.property.get
Get Product Property by ID crm.product.property.get
crm_product_property_get body → 2004XX
POST
/crm.product.property.list
Get a List of Product Properties crm.product.property.list
crm_product_property_list body → 2004XX
POST
/crm.product.property.settings.fields
Retrieve Additional Settings Fields for Custom Type crm.product.property.settings.fields
crm_product_property_settings_fields body → 2004XX
POST
/crm.product.property.types
Get a List of Product Property Types crm.product.property.types
crm_product_property_types body → 2004XX
POST
/crm.product.property.update
Update Product Property crm.product.property.update
crm_product_property_update body → 2004XX
POST
/crm.product.update
Update Product crm.product.update
crm_product_update body → 2004XX
POST
/crm.productrow.fields
Get Descriptions of Fields for Product Rows crm.productrow.fields
crm_productrow_fields body → 2004XX
POST
/crm.productrow.list
Get a List of Order Properties crm.productrow.list
crm_productrow_list body → 2004XX
POST
/crm.productsection.add
Add a New Product Section crm.productsection.add
crm_productsection_add body → 2004XX
POST
/crm.productsection.delete
Delete Product Section crm.productsection.delete
crm_productsection_delete body → 2004XX
POST
/crm.productsection.fields
Get Fields of the Product Section crm.productsection.fields
crm_productsection_fields body → 2004XX
POST
/crm.productsection.get
Get Product Section by ID crm.productsection.get
crm_productsection_get body → 2004XX
POST
/crm.productsection.list
Get a List of Sections from crm.productsection.list
crm_productsection_list body → 2004XX
POST
/crm.productsection.update
Update Product Section crm.productsection.update
crm_productsection_update body → 2004XX
POST
/crm.quote.add
Add Estimate crm.quote.add
crm_quote_add body → 2004XX
POST
/crm.quote.delete
Delete Estimate crm.quote.delete
crm_quote_delete body → 2004XX
POST
/crm.quote.fields
Get Fields of the Estimate crm.quote.fields
crm_quote_fields body → 2004XX
POST
/crm.quote.get
Get Estimate by ID: crm.quote.get
crm_quote_get body → 2004XX
POST
/crm.quote.list
Get a List of Estimates by Filter crm.quote.list
crm_quote_list body → 2004XX
POST
/crm.quote.productrows.get
Retrieve Product Rows of the Estimate crm.quote.productrows.get
crm_quote_productrows_get body → 2004XX
POST
/crm.quote.productrows.set
Set Product Rows for the Quote crm.quote.productrows.set
crm_quote_productrows_set body → 2004XX
POST
/crm.quote.update
Update Estimate crm.quote.update
crm_quote_update body → 2004XX
POST
/crm.quote.userfield.add
Create a Custom Field for Estimates crm.quote.userfield.add
crm_quote_userfield_add body → 2004XX
POST
/crm.quote.userfield.delete
Delete Custom Field for Quotes crm.quote.userfield.delete
crm_quote_userfield_delete body → 2004XX
POST
/crm.quote.userfield.get
Get Custom Field of Estimates by ID crm.quote.userfield.get
crm_quote_userfield_get body → 2004XX
POST
/crm.quote.userfield.list
Get a List of Custom Fields for crm.quote.userfield.list
crm_quote_userfield_list body → 2004XX
POST
/crm.quote.userfield.update
Update Existing Custom Field for Quotes crm.quote.userfield.update
crm_quote_userfield_update body → 2004XX
POST
/crm.requisite.add
Add Requisite crm.requisite.add
crm_requisite_add body → 2004XX
POST
/crm.requisite.bankdetail.add
Create a new bank detail crm.requisite.bankdetail.add
crm_requisite_bankdetail_add body → 2004XX
POST
/crm.requisite.bankdetail.delete
Delete bank detail crm.requisite.bankdetail.delete
crm_requisite_bankdetail_delete body → 2004XX
POST
/crm.requisite.bankdetail.fields
Get Description of Bank Details Fields crm.requisite.bankdetail.fields
crm_requisite_bankdetail_fields body → 2004XX
POST
/crm.requisite.bankdetail.get
Get bank details by id crm.requisite.bankdetail.get
crm_requisite_bankdetail_get body → 2004XX
POST
/crm.requisite.bankdetail.list
Get a list of bank details by filter crm.requisite.bankdetail.list
crm_requisite_bankdetail_list body → 2004XX
POST
/crm.requisite.bankdetail.update
Update Bank Details crm.requisite.bankdetail.update
crm_requisite_bankdetail_update body → 2004XX
POST
/crm.requisite.delete
Delete Requisite and Related Objects crm.requisite.delete
crm_requisite_delete body → 2004XX
POST
/crm.requisite.get
Get Requisite by ID crm.requisite.get
crm_requisite_get body → 2004XX
POST
/crm.requisite.link.get
Get the link of the requisite with the object crm.requisite.link.get
crm_requisite_link_get body → 2004XX
POST
/crm.requisite.link.list
Get a list of links for requisites crm.requisite.link.list
crm_requisite_link_list body → 2004XX
POST
/crm.requisite.link.register
Register Requisite Link with Object crm.requisite.link.register
crm_requisite_link_register body → 2004XX
POST
/crm.requisite.link.unregister
Unlink Requisite from Object crm.requisite.link.unregister
crm_requisite_link_unregister body → 2004XX
POST
/crm.requisite.list
Get a List of Requisites by Filter crm.requisite.list
crm_requisite_list body → 2004XX
POST
/crm.requisite.preset.add
Create a Template crm.requisite.preset.add
crm_requisite_preset_add body → 2004XX
POST
/crm.requisite.preset.countries
Get a list of countries for the template crm.requisite.preset.countries
crm_requisite_preset_countries body → 2004XX
POST
/crm.requisite.preset.delete
Delete the CRM Requisite Template crm.requisite.preset.delete
crm_requisite_preset_delete body → 2004XX
POST
/crm.requisite.preset.field.add
Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add
crm_requisite_preset_field_add body → 2004XX
POST
/crm.requisite.preset.field.availabletoadd
Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd
crm_requisite_preset_field_availabletoadd body → 2004XX
POST
/crm.requisite.preset.field.delete
Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete
crm_requisite_preset_field_delete body → 2004XX
POST
/crm.requisite.preset.field.fields
Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields
crm_requisite_preset_field_fields body → 2004XX
POST
/crm.requisite.preset.field.get
Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get
crm_requisite_preset_field_get body → 2004XX
POST
/crm.requisite.preset.field.list
Get a list of all customizable fields for a specified CRM requisites template crm.requisite.preset.field.list
crm_requisite_preset_field_list body → 2004XX
POST
/crm.requisite.preset.field.update
Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update
crm_requisite_preset_field_update body → 2004XX
POST
/crm.requisite.preset.fields
Get Description of the Fields of the Requisite Template crm.requisite.preset.fields
crm_requisite_preset_fields body → 2004XX
POST
/crm.requisite.preset.get
Get Requisite Template Fields by ID crm.requisite.preset.get
crm_requisite_preset_get body → 2004XX
POST
/crm.requisite.preset.list
Get a list of requisites templates by filter crm.requisite.preset.list
crm_requisite_preset_list body → 2004XX
POST
/crm.requisite.preset.update
Update Requisite Template crm.requisite.preset.update
crm_requisite_preset_update body → 2004XX
POST
/crm.requisite.update
Update Requisite crm.requisite.update
crm_requisite_update body → 2004XX
POST
/crm.requisite.userfield.add
Create a New Custom Field for crm.requisite.userfield.add
crm_requisite_userfield_add body → 2004XX
POST
/crm.requisite.userfield.delete
Delete User Field of Requisite crm.requisite.userfield.delete
crm_requisite_userfield_delete body → 2004XX
POST
/crm.requisite.userfield.get
Get User Field by ID crm.requisite.userfield.get
crm_requisite_userfield_get body → 2004XX
POST
/crm.requisite.userfield.list
Get a list of custom fields of the requisite by filter crm.requisite.userfield.list
crm_requisite_userfield_list body → 2004XX
POST
/crm.settings.mode.get
Determine the Current CRM Operating Mode crm.settings.mode.get
crm_settings_mode_get body → 2004XX
POST
/crm.stagehistory.list
Get Stage History with crm.stagehistory.list
crm_stagehistory_list body → 2004XX
POST
/crm.status.add
Create CRM Status Element crm.status.add
crm_status_add body → 2004XX
POST
/crm.status.delete
Delete CRM Status Element crm.status.delete
crm_status_delete body → 2004XX
POST
/crm.status.entity.items
Get directory items by type crm.status.entity.items
crm_status_entity_items body → 2004XX
POST
/crm.status.get
Get a directory item by ID crm.status.get
crm_status_get body → 2004XX
POST
/crm.status.list
Get a List of Directory Items by Filter crm.status.list
crm_status_list body → 2004XX
POST
/crm.status.update
Update CRM Status Element crm.status.update
crm_status_update body → 2004XX
POST
/crm.timeline.bindings.bind
Add Timeline Record Binding to CRM Entity crm.timeline.bindings.bind
crm_timeline_bindings_bind body → 2004XX
POST
/crm.timeline.bindings.fields
Get CRM entity bindings fields and timeline record in crm.timeline.bindings.fields
crm_timeline_bindings_fields body → 2004XX
POST
/crm.timeline.bindings.list
Get the list of bindings for a record in the timeline crm.timeline.bindings.list
crm_timeline_bindings_list body → 2004XX
POST
/crm.timeline.bindings.unbind
Unbind Timeline Record from CRM Entity crm.timeline.bindings.unbind
crm_timeline_bindings_unbind body → 2004XX
POST
/crm.timeline.comment.add
Add Comment crm.timeline.comment.add
crm_timeline_comment_add body → 2004XX
POST
/crm.timeline.comment.delete
Delete Comment crm.timeline.comment.delete
crm_timeline_comment_delete body → 2004XX
POST
/crm.timeline.comment.fields
Get Fields of crm.timeline.comment.fields
crm_timeline_comment_fields body → 2004XX
POST
/crm.timeline.comment.get
Get Information About the Comment crm.timeline.comment.get
crm_timeline_comment_get body → 2004XX
POST
/crm.timeline.comment.list
Get a List of Comments from crm.timeline.comment.list
crm_timeline_comment_list body → 2004XX
POST
/crm.timeline.comment.update
Update Comment crm.timeline.comment.update
crm_timeline_comment_update body → 2004XX
POST
/crm.timeline.icon.add
Add Icon to crm.timeline.icon.add
crm_timeline_icon_add body → 2004XX
POST
/crm.timeline.icon.delete
Delete Icon crm.timeline.icon.delete
crm_timeline_icon_delete body → 2004XX
POST
/crm.timeline.icon.get
Get Information About the crm.timeline.icon.get
crm_timeline_icon_get body → 2004XX
POST
/crm.timeline.icon.list
Get a List of Available Icons crm.timeline.icon.list
crm_timeline_icon_list body → 2004XX
POST
/crm.timeline.item.pin
Pinning an Item in the Timeline crm.timeline.item.pin
crm_timeline_item_pin body → 2004XX
POST
/crm.timeline.item.unpin
Unpin Timeline Item in crm.timeline.item.unpin
crm_timeline_item_unpin body → 2004XX
POST
/crm.timeline.layout.blocks.delete
Delete a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.delete
crm_timeline_layout_blocks_delete body → 2004XX
POST
/crm.timeline.layout.blocks.get
Retrieve a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.get
crm_timeline_layout_blocks_get body → 2004XX
POST
/crm.timeline.layout.blocks.set
Set a Set of Additional Content Blocks in the CRM Timeline Record: crm.timeline.layout.blocks.set
crm_timeline_layout_blocks_set body → 2004XX
POST
/crm.timeline.logmessage.add
Add Log Entry crm.timeline.logmessage.add
crm_timeline_logmessage_add body → 2004XX
POST
/crm.timeline.logmessage.delete
Delete log entry crm.timeline.logmessage.delete
crm_timeline_logmessage_delete body → 2004XX
POST
/crm.timeline.logmessage.get
Get Information About the Log Entry crm.timeline.logmessage.get
crm_timeline_logmessage_get body → 2004XX
POST
/crm.timeline.logmessage.list
Get a List of Timeline Log Entries crm.timeline.logmessage.list
crm_timeline_logmessage_list body → 2004XX
POST
/crm.timeline.logo.add
Add Logo crm.timeline.logo.add
crm_timeline_logo_add body → 2004XX
POST
/crm.timeline.logo.delete
Delete logo crm.timeline.logo.delete
crm_timeline_logo_delete body → 2004XX
POST
/crm.timeline.logo.get
Get Information About the Logo crm.timeline.logo.get
crm_timeline_logo_get body → 2004XX
POST
/crm.timeline.logo.list
Get a list of available logos crm.timeline.logo.list
crm_timeline_logo_list body → 2004XX
POST
/crm.timeline.note.delete
Delete Note crm.timeline.note.delete
crm_timeline_note_delete body → 2004XX
POST
/crm.timeline.note.get
Get Information About the Note crm.timeline.note.get
crm_timeline_note_get body → 2004XX
POST
/crm.timeline.note.save
Save Note crm.timeline.note.save
crm_timeline_note_save body → 2004XX
POST
/crm.tracking.trace.add
Create a Sales Intelligence Trace: crm.tracking.trace.add
crm_tracking_trace_add body → 2004XX
POST
/crm.tracking.trace.delete
Delete Sales Intelligence Trace crm.tracking.trace.delete
crm_tracking_trace_delete body → 2004XX
POST
/crm.type.add
Create a new custom type crm.type.add
crm_type_add body → 2004XX
POST
/crm.type.delete
Delete user type crm.type.delete
crm_type_delete body → 2004XX
POST
/crm.type.fields
Get Custom Type Fields crm.type.fields
crm_type_fields body → 2004XX
POST
/crm.type.get
Get the user type by id crm.type.get
crm_type_get body → 2004XX
POST
/crm.type.getByEntityTypeId
Get the user type by entityTypeId crm.type.getByEntityTypeId
crm_type_getByEntityTypeId body → 2004XX
POST
/crm.type.list
Get a list of custom types crm.type.list
crm_type_list body → 2004XX
POST
/crm.type.update
Update User Type crm.type.update
crm_type_update body → 2004XX
POST
/crm.userfield.enumeration.fields
Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields
crm_userfield_enumeration_fields body → 2004XX
POST
/crm.userfield.fields
Get Description for Custom Fields crm.userfield.fields
crm_userfield_fields body → 2004XX
POST
/crm.userfield.settings.fields
Get Field Settings Description for Custom Field Type crm.userfield.settings.fields
crm_userfield_settings_fields body → 2004XX
POST
/crm.userfield.types
Get a list of custom field types crm.userfield.types
crm_userfield_types body → 2004XX
POST
/crm.vat.add
Create VAT Rate crm.vat.add
crm_vat_add body → 2004XX
POST
/crm.vat.delete
Delete VAT Rate crm.vat.delete
crm_vat_delete body → 2004XX
POST
/crm.vat.fields
Get VAT Rate Fields crm.vat.fields
crm_vat_fields body → 2004XX
POST
/crm.vat.get
Get VAT Rate by ID crm.vat.get
crm_vat_get body → 2004XX
POST
/crm.vat.list
Get a List of VAT Rates by Filter crm.vat.list
crm_vat_list body → 2004XX
POST
/crm.vat.update
Update Existing VAT Rate crm.vat.update
crm_vat_update body → 2004XX
POST
/ctrigger.delete
Delete Trigger ctrigger.delete
ctrigger_delete body → 2004XX
POST
/salescenter.payment.getPublicUrl
Generate a Link for a Specific Payment salescenter.payment.getPublicUrl
salescenter_payment_getPublicUrl body → 2004XX
POST
/userfieldconfig.add
Add Custom Field userfieldconfig.add
userfieldconfig_add body → 2004XX
POST
/userfieldconfig.delete
Delete User Field userfieldconfig.delete
userfieldconfig_delete body → 2004XX
POST
/userfieldconfig.get
Get User Field Settings userfieldconfig.get
userfieldconfig_get body → 2004XX
POST
/userfieldconfig.getTypes
Get Available User Field Types userfieldconfig.getTypes
userfieldconfig_getTypes body → 2004XX
POST
/userfieldconfig.list
Get a List of User Field Settings userfieldconfig.list
userfieldconfig_list body → 2004XX
POST
/userfieldconfig.update
Update User Field userfieldconfig.update
userfieldconfig_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-crm-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
AE Profile APIs.io
Bitrix24 BIconnector API
AE Profile APIs.io
Bitrix24 Business Processes API
AE Profile APIs.io
Bitrix24 Calendar API
AE Profile APIs.io
Bitrix24 Chatbots API
AE Profile APIs.io
Bitrix24 Chats API
AE Profile APIs.io
Bitrix24 Company Structure API
AE Profile APIs.io
Bitrix24 CoPilot / AI API
AE Profile APIs.io
Bitrix24 Data Storage API
AE Profile APIs.io
Bitrix24 Deprecated Methods API
AE Profile APIs.io
Bitrix24 Document Generator API
AE Profile APIs.io
Bitrix24 Drive API
AE Profile APIs.io
#CRM
← Back to B APIs
API Details
ID
bitrix24:bitrix24-crm-api
Base URL
https://{installation}.bitrix24.com/rest/
Docs
https://apidocs.bitrix24.com/
Provider
Bitrix24
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bitrix24-crm-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bitrix24-crm-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bitrix24 CRM API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.