Skip to content

MngGetDesksByFilter

Requires see_customers. The response includes only desks visible through manager brand and desks scope loaded from the cached staff manager record.

Returns paginated CRM desk records.

Request Parameters

Name Type Required Description
limit int Yes Maximum rows, from 1 to 50000
offset int Yes Pagination offset
where array No [[field, operator, value], ...]
orWhere array No OR comparison group in [[field, operator, value], ...] format; at least one condition must match
whereNot array No [[field, value], ...]
whereIn array No [[field, [values...]], ...]
whereNotIn array No [[field, [values...]], ...]
whereBetween array No [[field, [from, to]], ...]
whereNotBetween array No [[field, [from, to]], ...]
orderBy array No Example: [["sort_index", "asc"]]

Supported filter fields:

  • desk
  • brand
  • name
  • status
  • enable
  • manager_id
  • sort_index
  • created_time
  • updated_time

Request

{
  "command": "MngGetDesksByFilter",
  "extID": "1",
  "data": {
    "limit": 100,
    "offset": 0,
    "where": [
      ["brand", "=", "default"],
      ["enable", "=", 1]
    ],
    "orderBy": [
      ["sort_index", "asc"]
    ]
  }
}

Response Data

{
  "rows": [
    {
      "desk": "DESK_RETENTION",
      "brand": "default",
      "name": "Retention",
      "status": 0,
      "enable": 1,
      "manager_id": 10,
      "sort_index": 100,
      "created_time": 1710000000,
      "updated_time": 1710000000
    }
  ],
  "count": 1
}