MngGetLeadsByFilter¶
Returns paginated leads. The table response masks email and phone; filters use full cached values.
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], ...] |
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": "MngGetLeadsByFilter",
"extID": "1",
"data": {
"limit": 100,
"offset": 0,
"where": [
["brand", "=", "default"],
["status", "=", 0]
],
"orderBy": [
["created_time", "desc"]
]
}
}
Response Data¶
{
"rows": [
{
"lead_id": 1,
"brand": "default",
"full_name": "Anna Test",
"email": "an***@example.com",
"phone": "+44***000",
"status": 0
}
],
"count": 1
}