MngGetCustomersByFilter

Returns a paginated customer list.

email and phone are masked in this list response. Email domain remains visible. Filtering works against full stored values.

Access Control

Requires CRM access and see_customers. The requested deskFilter is intersected with the manager desk scope unless the manager has see_all_customers or admin scope. Customer brand must match manager brand when brand scope is set.

Request Parameters

Name	Type	Required	Description
limit	int	Yes	Maximum rows, from 1 to 50000
offset	int	Yes	Pagination offset
deskFilter	string	Yes	Desk wildcard mask, for example *, DESK_*, DESK_EU*,!DESK_EU_TEST
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: [["created_time", "desc"]]

Request

{
  "command": "MngGetCustomersByFilter",
  "extID": "1",
  "data": {
    "limit": 50,
    "offset": 0,
    "deskFilter": "DESK_*",
    "where": [
      ["email", "like", "example.com"]
    ],
    "orderBy": [
      ["created_time", "desc"]
    ]
  }
}

Response Data

{
  "structure": [
    "customer_id",
    "external_id",
    "type",
    "status",
    "enable",
    "enable_otp",
    "deposit_allowed",
    "withdrawal_allowed",
    "first_name",
    "last_name",
    "middle_name",
    "full_name",
    "birth_date",
    "citizenship",
    "country_of_residence",
    "email",
    "phone",
    "preferred_language",
    "timezone",
    "brand",
    "desk",
    "manager_id",
    "lead_source",
    "campaign",
    "affiliate_id",
    "introducer_id",
    "assigned_manager_id",
    "crm_stage",
    "segment",
    "tags_json",
    "email_verified",
    "phone_verified",
    "marketing_allowed",
    "tax_id",
    "national_id",
    "pep_status",
    "sanctions_status",
    "risk_level",
    "aml_status",
    "kyc_status",
    "sales_status",
    "risk_status",
    "finance_status",
    "kyc_updated_time",
    "aml_updated_time",
    "last_contact_time",
    "next_contact_time",
    "conversion_time",
    "last_login_time",
    "created_time",
    "updated_time",
    "created_by",
    "updated_by",
    "meta_json"
  ],
  "rows": [
    [
      1,
      "",
      0,
      0,
      1,
      0,
      1,
      1,
      "John",
      "Smith",
      "",
      "John Smith",
      0,
      "",
      "",
      "cl***@example.com",
      "+35***000",
      "",
      "",
      "default",
      0,
      10,
      "",
      "",
      "",
      "",
      10,
      "qualified",
      "",
      "",
      0,
      0,
      0,
      "",
      "",
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      1777700000,
      1777700000,
      10,
      10,
      ""
    ]
  ],
  "count": 1
}