Documentation

crm.category.get

Scope: catalog Permissions to execute: for all

crm.category.get({entityTypeId: number, id: number})

Passes category information with id.

Parameters

Parameter Description
entityTypeIdCRM entity type ID.
idCategory ID.

Response:


{
	"category": {
		"id": 53,
		"name": "General",
		"sort": 500,
		"entityTypeId": 170,
		"isDefault": "N"
	}
}

Here:

  • id - category ID.
  • name - category name.
  • sort - sort index.
  • entityTypeId - CRM entity type ID from this category.
  • isDefault - default category attribute.

Response for some entities can be expanded by additional fields.



© «Bitrix24», 2001-2024