Skip to content

GetClientLeadsRequestDto

← Lead / Client DTO

Filters for GET Api/ClientLeads. Every field except pagination is optional — an absent field means the condition is not applied. Passing several narrows by all of them.

Поля

ПолеТипОбязательноеОписание
paginationPaginationда
searchQuerystringнетFull-text search over name, city and postal code together. Independent of the per-field filters below; word-based, so it does not match a partial word.
createFromFilterstringнетISO date. Kept for compatibility — createdAt is the range form.
createToFilterstringнетISO date. Kept for compatibility — createdAt is the range form.
namestringнетPrefix match on the name.
citystringнетPrefix match on the city.
postalCodestringнетPrefix match on the postal code.
createdAtPaginationRangeFilter<string>нетISO 8601 range over the creation timestamp.
updatedAtPaginationRangeFilter<string>нетISO 8601 range over the last-update timestamp. Leads never updated are excluded.
householdSupportHouseholdSupportDto[]нетMatches leads having any of the listed household support values.
currentSituationCurrentSituationDto[]нетMatches leads having any of the listed current situation values.
utmSourcestringнетPrefix match on the UTM source.
utmMediumstringнетPrefix match on the UTM medium.
utmCampaignstringнетPrefix match on the UTM campaign.
utmTermstringнетPrefix match on the UTM term.
utmContentstringнетPrefix match on the UTM content.
pageUrlstringнетPrefix match on the landing page URL.
pageTitlestringнетSubstring match on the landing page title.
referrerstringнетPrefix match on the referrer.
linkedClientIdnumberнетClient this lead was converted into.
phoneNumberstringнетExact match against the linked phone contacts. Normalized before comparison (digits only, 49-prefixed), so a partial number does not match.
emailstringнетExact match against the linked email contacts. Stored as a value object, so a partial address does not match — pass the full address.

Пример

json
{
  "pagination": "<Pagination>",
  "searchQuery": "string",
  "createFromFilter": "string",
  "createToFilter": "string",
  "name": "string",
  "city": "string",
  "postalCode": "string",
  "createdAt": "<PaginationRangeFilter<string>>",
  "updatedAt": "<PaginationRangeFilter<string>>",
  "householdSupport": [],
  "currentSituation": [],
  "utmSource": "string",
  "utmMedium": "string",
  "utmCampaign": "string",
  "utmTerm": "string",
  "utmContent": "string",
  "pageUrl": "https://...",
  "pageTitle": "string",
  "referrer": "string",
  "linkedClientId": 0,
  "phoneNumber": "+49123456789",
  "email": "user@example.com"
}