Views: 2269
Last Modified: 31.08.2018

The method searches for departments

Revision: 19
Get information on the current API revision (platform version) – im.revision.get.


Parameter Example Req. Description Revision
FIND York Yes Search phase 19
USER_DATA N No Download user data 19
OFFSET 0 No Offset of user selection 19
LIMIT 10 No User selection limit 19
  • If the parameter USER_DATA = Y, the manager data will be uploaded with the result.
  • Search is performed by the following fields: Department full name.
  • The method supports standard Bitrix24 REST API pagewise navigation. Additionally, it can build navigation via the OFFSET and LIMIT parameters.

Method call


BX24.callMethod('', {
	FIND: 'York'
}, function(result){


$result = restCommand('', Array(
	'FIND' => 'York'
), $_REQUEST["auth"]);	

Example of response

	"result": [
			id: 51,
			name: "New York branch",
			full_name: "New York branch / Bitrix24",
			manager_user_id: 11
	"total": 1

Description of keys:

  • id – department ID
  • name – department abbreviated name
  • full_name – department full name
  • manager_user_data – manager data description object (unavailable, if USER_DATA != 'Y')
    • id – user ID
    • name – user first and last name
    • first_name – user name
    • last_name – user last name
    • work_position – position
    • color – user color in 'hex' format
    • avatar – link to avatar (if empty, avatar is not specified)
    • gender – user gender
    • birthday – user birthday in the DD-MM format, if empty – not specified
    • extranet – extranet user attribute (true/false)
    • network – Bitrix24.Network user attribute (true/false)
    • bot – bot attribute (true/false)
    • connector – Open Channel user attribute (true/false)
    • external_auth_id – external authorization code
    • status – selected user status
    • idle – date, when user is not using his/her PC, in ATOM format (if not specified, false)
    • last_activity_date – date of the last user action, in ATOM format
    • mobile_last_date – date of the last action inside mobile app, in ATOM format (if not specified, false)
    • absent – date, to which the user has a leave of absence, in ATOM format (if not specified, false)

Example of response when error occurs

    "error": "FIND_SHORT",
    "error_description": "Too short a search phrase."

Description of keys:

  • error – error code
  • error_description – brief description of error

Possible error codes

Code Description
FIND_SHORT Search phrase is top short, search is performed with three symbols minimum.

Attention! The method is specified with using of the restCommand function. This method is used to send data in Bitrix24 and is available in the EchoBot example as well as in this article. You can use your own function or BX24.callMethod, or bitrix24-php-sdk JavaScript methods.

Courses developed by «Bitrix», Inc.