MngGetClientsListByDesk¶

Returns a short client list for the desks visible to the caller, for pickers and autocomplete rather than for tables.

The command is available through the manager command API only; there is no REST path for it. The kind is fixed by the command name, so customer_kind is not accepted on input. See Clients and Leads Commands.

It replaces the deprecated MngGetCustomersListByDesk.

Access Control¶

Allowed sessions:

SESSION_MANAGER
SESSION_ADMIN
SESSION_DEALER
SESSION_CRM_MANAGER
SESSION_CRM_ADMIN

The caller must have CRM access and see_clients. The list covers the manager desk scope; see_all_clients widens it within the brand.

Request¶

The command takes no parameters.

{
  "command": "MngGetClientsListByDesk",
  "extID": "1",
  "data": {}
}

Response Data¶

{
  "structure": ["customer_id", "full_name", "email"],
  "rows": [
    [1, "John Smith", "cl***@example.com"]
  ]
}

Field	Type	Description
`structure`	array	Ordered column names
`rows`	array	One nested array per record

Each row carries customer_id, full_name, and a masked email. The response holds no other fields and no contact data in open form, so it needs no contact permission.

Errors¶

HTTP	Error	Description
`400`	`INVALID_DATA`	Request validation failed
`403`	`RET_NOT_ENOUGH_RIGHTS`	Missing permission, missing scope, or the record is outside the caller's visibility
`404`	`RET_NOT_FOUND`	No customer with that identifier exists

Every error carries a message field with free-form text. Its contents are not part of the contract; branch on error.